uart.h

Go to the documentation of this file.
00001 /*
00002  *  Copyright (c) 2008  Swedish Institute of Computer Science
00003  *  All rights reserved.
00004  *
00005  *  Redistribution and use in source and binary forms, with or without
00006  *  modification, are permitted provided that the following conditions are met:
00007  *
00008  *  * Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  *  * Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in
00012  *    the documentation and/or other materials provided with the
00013  *    distribution.
00014  *  * Neither the name of the copyright holders nor the names of
00015  *    contributors may be used to endorse or promote products derived
00016  *    from this software without specific prior written permission.
00017  *
00018  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00019  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00020  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00021  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
00022  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00023  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00024  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00025  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00026  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00027  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00028  * POSSIBILITY OF SUCH DAMAGE.
00029  */
00030 /**
00031  * \file
00032  *
00033  * \brief
00034  *      Handles the control of the USART for communication with the ATmega1284p
00035  *      for sending commands.
00036  *
00037  * \author
00038  *      Mike Vidales mavida404@gmail.com
00039  *
00040  */
00041 
00042 #ifndef __UART_H__
00043 #define __UART_H__   1
00044 
00045 #include <inttypes.h>
00046 
00047 /** \name ASCII characters defined */
00048 /** \{ */
00049 #define SOF_CHAR            (0x01)  /**< Start-of-frame character. */
00050 #define EOF_CHAR            (0x04)  /**< End-of-frame character. */
00051 /** \} */
00052 
00053 /* Macros & Defines */
00054 
00055 #define BUFSIZE 80
00056 #define BAUD_RATE_38400     (12)
00057 
00058 /** \brief Circular buffer structure */
00059 typedef struct {
00060     volatile uint8_t head;  /**< Index to last available character in buffer. */
00061     volatile uint8_t tail;  /**< Index to first available character in buffer. */
00062     uint8_t buf[BUFSIZE];   /**< The actual buffer used for storing characters. */
00063 } tcirc_buf;
00064 
00065 extern tcirc_buf rxbuf;
00066 #define rx_char_ready() (rxbuf.head != rxbuf.tail)
00067 
00068 /* Serial port functions */
00069 void uart_init(void);
00070 void uart_deinit(void);
00071 uint8_t uart_circ_buf_has_char(tcirc_buf *cbuf);
00072 void uart_clear_rx_buf(void);
00073 uint8_t uart_get_char_rx(void);
00074 void uart_send_byte(uint8_t byte);
00075 void uart_serial_send_frame(uint8_t cmd, uint8_t payload_length, uint8_t *payload);
00076 void uart_serial_rcv_frame(uint8_t wait_for_it);
00077 
00078 #endif /* __UART_H__ */

Generated on Mon Apr 11 14:23:38 2011 for Contiki 2.5 by  doxygen 1.6.1