forked from Imagelibrary/rtems
Added information to README.mc68681.
Created the basic README and the README.z85c30.
This commit is contained in:
Joel Sherrill
17
c/src/lib/libchip/serial/README
Normal file
17
c/src/lib/libchip/serial/README
Normal file
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
74
c/src/lib/libchip/serial/README.z85c30
Normal file
74
c/src/lib/libchip/serial/README.z85c30
Normal file
@@ -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.
|
||||
|
||||
17
c/src/libchip/serial/README
Normal file
17
c/src/libchip/serial/README
Normal file
@@ -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.
|
||||
|
||||
@@ -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.
|
||||
|
||||
|
||||
74
c/src/libchip/serial/README.z85c30
Normal file
74
c/src/libchip/serial/README.z85c30
Normal file
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user