diff options
author | Joel Sherrill <joel.sherrill@OARcorp.com> | 1998-07-09 18:36:19 +0000 |
---|---|---|
committer | Joel Sherrill <joel.sherrill@OARcorp.com> | 1998-07-09 18:36:19 +0000 |
commit | 80b1c2f87fdd1334121f056e7c4231397abef6a6 (patch) | |
tree | a8ac6ab9c7091e3d2464f88b631302bfc47ab4cb /c/src/lib/libchip/serial/README | |
parent | changed version to 980707 (diff) | |
download | rtems-80b1c2f87fdd1334121f056e7c4231397abef6a6.tar.bz2 |
Added information to README.mc68681.
Created the basic README and the README.z85c30.
Diffstat (limited to '')
-rw-r--r-- | c/src/lib/libchip/serial/README | 17 | ||||
-rw-r--r-- | c/src/lib/libchip/serial/README.mc68681 | 48 | ||||
-rw-r--r-- | c/src/lib/libchip/serial/README.z85c30 | 74 |
3 files changed, 136 insertions, 3 deletions
diff --git a/c/src/lib/libchip/serial/README b/c/src/lib/libchip/serial/README new file mode 100644 index 0000000000..3a1013b45b --- /dev/null +++ b/c/src/lib/libchip/serial/README @@ -0,0 +1,17 @@ +# +# $Id$ +# + +This is the serial controller portion of the libchip library. This +directory contains the source code for reusable console driver +support code. Each individual driver is configured using the +console_tbl data structure. This structure is defined and explained +in the console.h file. + +The reusable chip drivers do not directly access the serial controller. +They access the registers on the controller via a set of up to four +functions which are provided by the BSP. These functins set and get +general registers and data buffers. Some chips can access the data +buffers as general registers and thus the driver may not require +those interface routines. + diff --git a/c/src/lib/libchip/serial/README.mc68681 b/c/src/lib/libchip/serial/README.mc68681 index 4364dac5d5..455527c41e 100644 --- a/c/src/lib/libchip/serial/README.mc68681 +++ b/c/src/lib/libchip/serial/README.mc68681 @@ -5,10 +5,37 @@ Configuration Table Use ======================= +sDeviceName + + The name of this device. + +pDeviceFns + + The device interface control table. This may be: + + mc68681_fns for interrupt driven IO + + mc68681_fns_polled for polled IO + +deviceProbe + + This is the address of the routine which probes to see if the device + is present. + pDeviceFlow This field is ignored as hardware flow control is not currently supported. +ulMargin + + This is currently unused. + +ulHysteresis + + This is currently unused. + +pDeviceParams + + This is set to the default settings. + ulCtrlPort1 This field is the base address of the entire DUART. @@ -20,20 +47,35 @@ ulCtrlPort2 ulDataPort This field is bit mapped as follows: - bit 0: 0 or 1 to indicate the A or B port on the DUART. - bit 1: baud rate set a or b - + bit 0: baud rate set a or b + bit 1-2: BRG selection ("Select Extend bit") Note: If both ports on single DUART are not configured for the same baud rate set, then unexpected results will occur. + Note: On the Exar 88c681, if a standard clock of 3.6864 Mhz is used + and the "Select Extend bit" is 0 (disabled), then the default + MC68681 baud rate table is selected. + getRegister setRegister + These follow standard conventions. getData setData + These are unused since the TX and RX data registers can be accessed as regular registers. +ulClock + + This is either NULL or a pointer to a baud rate mapping table. If + NULL, then the CSR/ACR/X bit mappings shown in the 68681 and 88681 + manuals are used. Otherwise, the board specific baud rate mapping + is used. + +ulIntVector + + This is the interrupt vector number associated with this chip. diff --git a/c/src/lib/libchip/serial/README.z85c30 b/c/src/lib/libchip/serial/README.z85c30 new file mode 100644 index 0000000000..d3a91438ba --- /dev/null +++ b/c/src/lib/libchip/serial/README.z85c30 @@ -0,0 +1,74 @@ +# +# $Id$ +# + +Configuration Table Use +======================= + +sDeviceName + + The name of this device. + +pDeviceFns + + The device interface control table. This may be: + + z85c30_fns for interrupt driven IO + + z85c30_fns_polled for polled IO + +deviceProbe + + This is the address of the routine which probes to see if the device + is present. + +pDeviceFlow + + This field is set to one of the following values: + + NULL for no hardware flow control + + z85c30_flow_RTSCTS for RTS/CTS based flow control + + z85c30_flow_DTRCTS for DTR/CTS based flow control + +ulMargin + + This is currently unused. + +ulHysteresis + + This is currently unused. + +pDeviceParams + + This is set to the default settings. + +ulCtrlPort1 + + This field is the address of the control register for this port. + +ulCtrlPort2 + + This field is the address of the control register for chip. + +ulDataPort + + This field is the address of the data register for this port. + +getRegister +setRegister + + These follow standard conventions. + +getData +setData + + These follow standard conventions. + +ulClock + + This is the clock speed of the baud rate clock. + NULL, then the CSR/ACR/X bit mappings shown in the 68681 and 88681 + manuals are used. Otherwise, the board specific baud rate mapping + is used. + +ulIntVector + + This is the interrupt vector number associated with this chip. + |