Changeset 5ae415b in rtems


Ignore:
Timestamp:
Jul 5, 1998, 11:04:31 AM (22 years ago)
Author:
Joel Sherrill <joel.sherrill@…>
Branches:
4.10, 4.11, 4.8, 4.9, master
Children:
1d22b03
Parents:
bc2ebb4
Message:

Added include of termios.h.

Also added a block of comments above the console_tbl structure to explain
each entry.

Location:
c/src
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • c/src/lib/libchip/serial/serial.h

    rbc2ebb4 r5ae415b  
    2323#define __LIBCHIP_SERIAL_h
    2424
     25#include <termios.h>
    2526#include <ringbuf.h>
    2627
     
    5152  int (*deviceStartRemoteTx)(int minor);
    5253} console_flow;
     54
     55/*
     56 * Each field is interpreted thus:
     57 *
     58 * sDeviceName  This is the name of the device.
     59 *
     60 * pDeviceFns   This is a pointer to the set of driver routines to use.
     61 *
     62 * pDeviceFlow  This is a pointer to the set of flow control routines to
     63 *              use. Serial device drivers will typically supply RTSCTS
     64 *              and DTRCTS handshake routines for DCE to DCE communication,
     65 *              however for DCE to DTE communication, no such routines
     66 *              should be necessary as RTS will be driven automatically
     67 *              when the transmitter is active.
     68 *
     69 * ulMargin     The high water mark in the input buffer is set to the buffer
     70 *              size less ulMargin. Once this level is reached, the driver's
     71 *              flow control routine used to stop the remote transmitter will
     72 *              be called. This figure should be greater than or equal to
     73 *              the number of stages of FIFO between the transmitter and
     74 *              receiver.
     75 *
     76 *              NOTE: At the current time, this parameter is hard coded
     77 *                    in termios and this number is ignored.
     78 *
     79 * ulHysteresis After the high water mark specified by ulMargin has been
     80 *              reached, the driver's routine to re-start the remote
     81 *              transmitter will be called once the level in the input
     82 *              buffer has fallen by ulHysteresis bytes.
     83 *
     84 *              NOTE: At the current time, this parameter is hard coded
     85 *                    in termios and this number is ignored.
     86 *
     87 * pDeviceParams This contains either device specific data or a pointer to a
     88 *              device specific structure containing additional information
     89 *              not provided in this table.
     90 *
     91 * ulCtrlPort1  This is the primary control port number for the device. This
     92 *              may be used to specify different instances of the same device
     93 *              type.
     94 *
     95 * ulCtrlPort2  This is the secondary control port number, of use when a given
     96 *              device has more than one available channel.
     97 *
     98 * ulDataPort   This is the port number for the data port of the device
     99 *
     100 * getRegister  This is the routine used to read register values.
     101 *
     102 * setRegister  This is the routine used to write register values.
     103 *
     104 * getData      This is the routine used to read the data register (RX).
     105 *
     106 * setData      This is the routine used to write the data register (TX).
     107 *
     108 * ulClock      This is the baud rate clock speed.
     109 *
     110 * ulIntVector  This encodes the interrupt vector of the device.
     111 */
    53112
    54113typedef struct _console_tbl {
  • c/src/libchip/serial/serial.h

    rbc2ebb4 r5ae415b  
    2323#define __LIBCHIP_SERIAL_h
    2424
     25#include <termios.h>
    2526#include <ringbuf.h>
    2627
     
    5152  int (*deviceStartRemoteTx)(int minor);
    5253} console_flow;
     54
     55/*
     56 * Each field is interpreted thus:
     57 *
     58 * sDeviceName  This is the name of the device.
     59 *
     60 * pDeviceFns   This is a pointer to the set of driver routines to use.
     61 *
     62 * pDeviceFlow  This is a pointer to the set of flow control routines to
     63 *              use. Serial device drivers will typically supply RTSCTS
     64 *              and DTRCTS handshake routines for DCE to DCE communication,
     65 *              however for DCE to DTE communication, no such routines
     66 *              should be necessary as RTS will be driven automatically
     67 *              when the transmitter is active.
     68 *
     69 * ulMargin     The high water mark in the input buffer is set to the buffer
     70 *              size less ulMargin. Once this level is reached, the driver's
     71 *              flow control routine used to stop the remote transmitter will
     72 *              be called. This figure should be greater than or equal to
     73 *              the number of stages of FIFO between the transmitter and
     74 *              receiver.
     75 *
     76 *              NOTE: At the current time, this parameter is hard coded
     77 *                    in termios and this number is ignored.
     78 *
     79 * ulHysteresis After the high water mark specified by ulMargin has been
     80 *              reached, the driver's routine to re-start the remote
     81 *              transmitter will be called once the level in the input
     82 *              buffer has fallen by ulHysteresis bytes.
     83 *
     84 *              NOTE: At the current time, this parameter is hard coded
     85 *                    in termios and this number is ignored.
     86 *
     87 * pDeviceParams This contains either device specific data or a pointer to a
     88 *              device specific structure containing additional information
     89 *              not provided in this table.
     90 *
     91 * ulCtrlPort1  This is the primary control port number for the device. This
     92 *              may be used to specify different instances of the same device
     93 *              type.
     94 *
     95 * ulCtrlPort2  This is the secondary control port number, of use when a given
     96 *              device has more than one available channel.
     97 *
     98 * ulDataPort   This is the port number for the data port of the device
     99 *
     100 * getRegister  This is the routine used to read register values.
     101 *
     102 * setRegister  This is the routine used to write register values.
     103 *
     104 * getData      This is the routine used to read the data register (RX).
     105 *
     106 * setData      This is the routine used to write the data register (TX).
     107 *
     108 * ulClock      This is the baud rate clock speed.
     109 *
     110 * ulIntVector  This encodes the interrupt vector of the device.
     111 */
    53112
    54113typedef struct _console_tbl {
Note: See TracChangeset for help on using the changeset viewer.