serial.h

Go to the documentation of this file.

/* SPDX-License-Identifier: BSD-2-Clause */
 
/*
 *  This file contains the TTY driver table definition
 *
 *  This driver uses the termios pseudo driver.
 *
 *  COPYRIGHT (c) 1989-1999.
 *  On-Line Applications Research Corporation (OAR).
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef __LIBCHIP_SERIAL_h
#define __LIBCHIP_SERIAL_h
 
#include <termios.h>
 
#include <rtems.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/*
 *  Types for get and set register routines
 */
 
typedef uint8_t   (*getRegister_f)(uintptr_t port, uint8_t reg);
 
typedef void      (*setRegister_f)(uintptr_t port, uint8_t reg, uint8_t  value);
 
typedef uint8_t   (*getData_f)(uintptr_t port);
 
typedef void      (*setData_f)(uintptr_t port, uint8_t value);
 
typedef struct _console_fns {
  bool    (*deviceProbe)(int minor);
  int     (*deviceFirstOpen)(int major, int minor, void *arg);
  int     (*deviceLastClose)(int major, int minor, void *arg);
  int     (*deviceRead)(int minor);
  ssize_t (*deviceWrite)(int minor, const char *buf, size_t len);
  void    (*deviceInitialize)(int minor);
  void    (*deviceWritePolled)(int minor, char cChar);
  int     (*deviceSetAttributes)(int minor, const struct termios *t);
  bool      deviceOutputUsesInterrupts;
} console_fns;
 
typedef struct _console_flow {
  int (*deviceStopRemoteTx)(int minor);
  int (*deviceStartRemoteTx)(int minor);
} console_flow;
 
 
typedef enum {
  SERIAL_MC68681,              /* Motorola MC68681 or Exar 88681 */
  SERIAL_NS16550,              /* National Semiconductor NS16550 */
  SERIAL_NS16550_WITH_FDR,     /* National Semiconductor NS16550
                                  with Fractional Divider Register (FDR) */
  SERIAL_Z85C30,               /* Zilog Z85C30 */
  SERIAL_CUSTOM                /* BSP specific driver */
} console_devs;
 
typedef struct _console_tbl {
  const char    *sDeviceName;
  console_devs   deviceType;
  const console_fns *pDeviceFns;
  bool         (*deviceProbe)(int minor);
  const console_flow *pDeviceFlow;
  uint32_t       ulMargin;
  uint32_t       ulHysteresis;
  void          *pDeviceParams;
  uint32_t       ulCtrlPort1;
  uint32_t       ulCtrlPort2;
  uint32_t       ulDataPort;
  getRegister_f  getRegister;
  setRegister_f  setRegister;
  getData_f      getData;
  /* This is the routine used to write the data register (TX). */
  setData_f      setData;
  uint32_t       ulClock;
  unsigned int   ulIntVector;
} console_tbl;
 
typedef struct _console_data {
  void                   *termios_data;
  volatile bool           bActive;
  void                   *pDeviceContext;
} console_data;
 
extern console_tbl   **Console_Port_Tbl;
extern unsigned long   Console_Port_Count;
 
extern console_tbl    Console_Configuration_Ports[];
extern unsigned long  Console_Configuration_Count;
 
extern console_data  *Console_Port_Data;
 
extern rtems_device_minor_number Console_Port_Minor;
 
void bsp_console_select(void);
 
#ifdef __cplusplus
}
#endif
 
#endif