summaryrefslogtreecommitdiffstats
path: root/bsps/shared/dev/serial/README
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
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')
-rw-r--r--bsps/shared/dev/serial/README13
1 files changed, 13 insertions, 0 deletions
diff --git a/bsps/shared/dev/serial/README b/bsps/shared/dev/serial/README
new file mode 100644
index 0000000000..59bb9e90fa
--- /dev/null
+++ b/bsps/shared/dev/serial/README
@@ -0,0 +1,13 @@
+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.
+