snickerdoodle Platform Controller
firmware for STM32F0 platform controller
sd_uart.h File Reference

UART Control. More...

Go to the source code of this file.

Data Structures

struct  sd_uart_dev
 UART device structure. More...
 

Macros

#define SD_UART_ERROR_NONE   ((uint32_t)0x00)
 
#define SD_UART_ERROR_PARITY   ((uint32_t)0x01)
 
#define SD_UART_ERROR_FRAMING   ((uint32_t)0x02)
 
#define SD_UART_ERROR_NOISE   ((uint32_t)0x04)
 
#define SD_UART_ERROR_OVERRUN   ((uint32_t)0x08)
 
#define __SD_UART_ERROR_IT(__HANDLE__)   ((__HANDLE__)->Instance->ISR & ((uint32_t)0x0F))
 Check whether an error interrupt has occured. Checks the 4 LSBs of the interrupt and status register (ISR) to determine if the overrun, noise, framing or parity error flags have been set. More...
 
#define __SD_UART_CLEAR_ERROR_IT(__HANDLE__)   ((__HANDLE__)->Instance->ICR = ((uint32_t)0x0F))
 Clear error interrupts Clears the 4 LSBs of the interrupt flag clear register (ICR). More...
 

Enumerations

enum  sd_uart_err {
  SD_UART_SUCCESS = 0x4A0D, SD_UART_NULL_ERROR, SD_UART_LOCKED, SD_UART_TIMEOUT,
  SD_UART_ERROR
}
 UART error enumeration. More...
 
enum  sd_uart_state { SD_UART_INITIALIZED = 0x0E60, SD_UART_READY, SD_UART_BUSY, SD_UART_OVERFLOW }
 UART state enumeration. More...
 

Functions

void sd_usart1_init (void)
 USART 1 Initialization.
 
void sd_usart2_init (void)
 USART 2 Initialization.
 
void sd_usart3_init (void)
 USART 3 Initialization.
 
enum sd_uart_err sd_uart_rx_init (struct sd_uart_dev *dev, struct sd_cbuf *rx_buff)
 UART Receive Interrupt Initialization Enable and prepare the UART to receive on interrupt. More...
 
enum sd_uart_err sd_uart_transmit (struct sd_uart_dev *dev, uint8_t *buf, uint32_t len, uint32_t timeout)
 Transmit Data In Blocking Mode. More...
 
void sd_uart_irqhandler (struct sd_uart_dev *dev)
 UART Interrupt Handler Handle interrupt events on the UART peripheral. More...
 

Detailed Description

UART Control.

Author
R. Bush bush@.nosp@m.krtk.nosp@m.l.com
Version
v1.0
Date
2016 March 28

Copyright (c) 2016, krtkl inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those of the authors and should not be interpreted as representing official policies, either expressed or implied, of the FreeBSD Project.