init commit of examples

Examples/SPISLAVEDMA/SPISLAVEDMA(3)/hal/documentation/spi_master_dma.rst

@@ -0,0 +1,56 @@
+The SPI Master DMA Driver
+==================================
+
+The serial peripheral interface (SPI) is a DMA serial communication
+interface.
+
+The SPI Master DMA driver uses DMA system to transfer data from
+a memory buffer to SPI (Memory to Peripheral), and receive data
+from SPI to a memory buffer (Peripheral to Memory).User must configure
+DMA system driver accordingly. A callback is called when all the data
+is transfered or all the data is received, if it is registered via 
+spi_m_dma_register_callback function.
+
+Features
+--------
+
+* Initialization/de-initialization
+* Enabling/disabling
+* Control of the following settings:
+
+  * Baudrate
+  * SPI mode
+  * Character size
+  * Data order
+* Data transfer: transmission, reception and full-duplex
+* Notifications about transfer completion and errors via callbacks
+
+Applications
+------------
+
+Send/receive/exchange data with a SPI slave device. E.g., serial flash, SD card,
+LCD controller, etc.
+
+Dependencies
+------------
+
+SPI master capable hardware and DMA hardware, with data sent/received.
+
+Concurrency
+-----------
+
+N/A
+
+Limitations
+-----------
+
+When only uses DMA channel to receive data, the transfer channel must enable to
+send dummy data to the slave.
+
+While read/write/transfer is in progress, the data buffer used must be kept
+unchanged.
+
+Known issues and workarounds
+----------------------------
+
+N/A

Examples/SPISLAVEDMA/SPISLAVEDMA(3)/hal/documentation/spi_slave_sync.rst

@@ -0,0 +1,60 @@
+The SPI Slave Synchronous Driver
+================================
+
+The serial peripheral interface (SPI) is a synchronous serial communication
+interface.
+
+SPI devices communicate in full duplex mode using a master-slave
+architecture with a single master. The slave device uses the control signal
+and clocks from master for reading and writing. Slave device is selected through
+slave select (SS) line.
+
+When data is read or written through the I/O writing function, the driver keeps
+polling until amount of characters achieved. Also it's possible to perform
+full-duplex read and write through transfer function, which process read and
+write at the same time.
+
+When SS detection is considered, a "break on SS detection" option can be enabled
+to make it possible to terminate the read/write/transfer on SS desertion.
+
+Features
+--------
+
+* Initialization/de-initialization
+* Enabling/disabling
+* Control of the following settings:
+
+  * SPI mode
+  * Character size
+  * Data order
+* Data transfer: transmission, reception and full-duplex
+
+Applications
+------------
+
+* SPI to I2C bridge that bridges SPI commands to I2C interface.
+
+Dependencies
+------------
+
+SPI slave capable hardware
+
+Concurrency
+-----------
+
+N/A
+
+Limitations
+-----------
+
+N/A
+
+Known issues and workarounds
+----------------------------
+
+When writing data through SPI slave, the time that the data appears on data line
+depends on the SPI hardware, and previous writing state, since there can be
+data in output fifo filled by previous broken transmitting. The number of such
+dummy/broken characters is limited by hardware. Whether these dummy/broken
+characters can be flushed is also limited by hardware.
+

Examples/SPISLAVEDMA/SPISLAVEDMA(3)/hal/documentation/usart_sync.rst

@@ -0,0 +1,58 @@
+The USART Synchronous Driver
+============================
+
+The universal synchronous and asynchronous receiver and transmitter
+(USART) is usually used to transfer data from one device to the other.
+
+User can set action for flow control pins by function usart_set_flow_control,
+if the flow control is enabled. All the available states are defined in union
+usart_flow_control_state.
+
+Note that user can set state of flow control pins only if automatic support of
+the flow control is not supported by the hardware.
+
+Features
+--------
+
+* Initialization/de-initialization
+* Enabling/disabling
+* Control of the following settings:
+
+  * Baudrate
+  * UART or USRT communication mode
+  * Character size
+  * Data order
+  * Flow control
+* Data transfer: transmission, reception
+
+Applications
+------------
+
+They are commonly used in a terminal application or low-speed communication
+between devices.
+
+Dependencies
+------------
+
+USART capable hardware.
+
+Concurrency
+-----------
+
+Write buffer should not be changed while data is being sent.
+
+
+Limitations
+-----------
+
+* The driver does not support 9-bit character size.
+* The "USART with ISO7816" mode can be only used in ISO7816 capable devices. 
+  And the SCK pin can't be set directly. Application can use a GCLK output PIN
+  to generate SCK. For example to communicate with a SMARTCARD with ISO7816
+  (F = 372 ; D = 1), and baudrate=9600, the SCK pin output frequency should be
+  config as 372*9600=3571200Hz. More information can be refer to ISO7816 Specification.
+
+Known issues and workarounds
+----------------------------
+
+N/A