core/uart/uart.h

   1 /**************************************************************************/
   2 /*!
   3     @file     uart.h
   4     @author   K. Townsend (microBuilder.eu)
   5     @date     22 March 2010
   6     @version  0.10
   7
   8     @section LICENSE
   9
  10     Software License Agreement (BSD License)
  11
  12     Copyright (c) 2010, microBuilder SARL
  13     All rights reserved.
  14
  15     Redistribution and use in source and binary forms, with or without
  16     modification, are permitted provided that the following conditions are met:
  17     1. Redistributions of source code must retain the above copyright
  18     notice, this list of conditions and the following disclaimer.
  19     2. Redistributions in binary form must reproduce the above copyright
  20     notice, this list of conditions and the following disclaimer in the
  21     documentation and/or other materials provided with the distribution.
  22     3. Neither the name of the copyright holders nor the
  23     names of its contributors may be used to endorse or promote products
  24     derived from this software without specific prior written permission.
  25
  26     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  27     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  30     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  31     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  33     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 */
  37 /**************************************************************************/
  38
  39 #ifndef __UART_H__
  40 #define __UART_H__
  41
  42 #include "projectconfig.h"
  43
  44 // Buffer used for circular fifo
  45 typedef struct _uart_buffer_t
  46 {
  47   uint8_t ep_dir;
  48   volatile uint8_t len;
  49   volatile uint8_t wr_ptr;
  50   volatile uint8_t rd_ptr;
  51   uint8_t buf[CFG_UART_BUFSIZE];
  52 } uart_buffer_t;
  53
  54 // UART Protocol control block
  55 typedef struct _uart_pcb_t
  56 {
  57   BOOL initialised;
  58   uint32_t baudrate;
  59   uint32_t status;
  60   uint32_t pending_tx_data;
  61   uart_buffer_t rxfifo;
  62 } uart_pcb_t;
  63
  64 void UART_IRQHandler(void);
  65 uart_pcb_t *uartGetPCB();
  66 void uartInit(uint32_t Baudrate);
  67 void uartSend(uint8_t *BufferPtr, uint32_t Length);
  68 void uartSendByte (uint8_t byte);
  69
  70 // Rx Buffer access control
  71 void uartRxBufferInit();
  72 uint8_t uartRxBufferRead();
  73 void uartRxBufferWrite(uint8_t data);
  74 void uartRxBufferClearFIFO();
  75 uint8_t uartRxBufferDataPending();
  76 bool uartRxBufferReadArray(byte_t* rx, size_t* len);
  77
  78 #endif