summaryrefslogtreecommitdiffstats
path: root/bsps/shared/dev/serial/README.mc68681
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2018-04-03 07:20:11 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2018-04-04 10:13:28 +0200
commit27de4e1fb8bcdbdd8cb882fc0d7a2c152b4e027a (patch)
treedef0664dcddc53fd5d599b455c64f76ca2293606 /bsps/shared/dev/serial/README.mc68681
parentbsps: Move config macros to RTEMS_BSP_CONFIGURE (diff)
downloadrtems-27de4e1fb8bcdbdd8cb882fc0d7a2c152b4e027a.tar.bz2
bsps: Move libchip to bsps
This patch is a part of the BSP source reorganization. Update #3285.
Diffstat (limited to 'bsps/shared/dev/serial/README.mc68681')
-rw-r--r--bsps/shared/dev/serial/README.mc6868183
1 files changed, 83 insertions, 0 deletions
diff --git a/bsps/shared/dev/serial/README.mc68681 b/bsps/shared/dev/serial/README.mc68681
new file mode 100644
index 0000000000..e0966d0e10
--- /dev/null
+++ b/bsps/shared/dev/serial/README.mc68681
@@ -0,0 +1,83 @@
+Configuration Table Use
+=======================
+
+sDeviceName
+
+ The name of this device.
+
+deviceType
+
+ This field must be SERIAL_MC68681.
+
+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.
+
+ulCtrlPort2
+
+ This field is the base address of the port specific registers.
+
+ulDataPort
+
+ This field is bit mapped as follows:
+ 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 a pointer to a baud rate mapping table. If set to
+ mc68681_baud_rate_table, 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.
+
+ NULL is not a valid value.
+
+ulIntVector
+
+ This is the interrupt vector number associated with this chip.
+