MAV'RIC
/home/travis/build/lis-epfl/MAVRIC_Library/hal/avr32/serial_avr32.hpp
00001 /*******************************************************************************
00002  * Copyright (c) 2009-2016, MAV'RIC Development Team
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  * 1. Redistributions of source code must retain the above copyright notice,
00009  * this list of conditions and the following disclaimer.
00010  *
00011  * 2. Redistributions in binary form must reproduce the above copyright notice,
00012  * this list of conditions and the following disclaimer in the documentation
00013  * and/or other materials provided with the distribution.
00014  *
00015  * 3. Neither the name of the copyright holder nor the names of its contributors
00016  * may be used to endorse or promote products derived from this software without
00017  * specific prior written permission.
00018  *
00019  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00020  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00021  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00022  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00023  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00024  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00025  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00026  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00027  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00028  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00029  * POSSIBILITY OF SUCH DAMAGE.
00030  ******************************************************************************/
00031 
00032 /*******************************************************************************
00033  * \file    serial_avr32.hpp
00034  *
00035  * \author  MAV'RIC Team
00036  *
00037  * \brief   Implementation of serial peripheral for avr32
00038  *
00039  ******************************************************************************/
00040 
00041 #ifndef SERIAL_AVR32_HPP_
00042 #define SERIAL_AVR32_HPP_
00043 
00044 #include "hal/common/serial.hpp"
00045 #include "util/buffer.hpp"
00046 
00047 extern "C"
00048 {
00049 #include "libs/asf/avr32/drivers/usart/usart.h"
00050 }
00051 
00055 typedef enum
00056 {
00057     AVR32_SERIAL_0          = 0,
00058     AVR32_SERIAL_1          = 1,
00059     AVR32_SERIAL_2          = 2,
00060     AVR32_SERIAL_3          = 3,
00061     AVR32_SERIAL_4          = 4,
00062     AVR32_SERIAL_MAX_NUMBER = 5,
00063 } serial_avr32_devices_t;
00064 
00065 
00069 typedef enum
00070 {
00071     AVR32_SERIAL_OFF    = 0,
00072     AVR32_SERIAL_IN     = 1,
00073     AVR32_SERIAL_OUT    = 2,
00074     AVR32_SERIAL_IN_OUT = 3,
00075 } serial_avr32_mode_t;
00076 
00077 
00081 typedef struct
00082 {
00083     uint8_t  pin;                       
00084     uint8_t  function;                  
00085 } serial_avr32_gpio_map_t;
00086 
00090 typedef struct
00091 {
00092     serial_avr32_devices_t  serial_device;
00093     serial_avr32_mode_t     mode;
00094     usart_options_t         options;
00095     serial_avr32_gpio_map_t rx_pin_map;
00096     serial_avr32_gpio_map_t tx_pin_map;
00097 } serial_avr32_conf_t;
00098 
00099 
00103 class Serial_avr32: public Serial
00104 {
00105 public:
00106 
00112     Serial_avr32(serial_avr32_conf_t config);
00113 
00114 
00121     bool init(void);
00122 
00123 
00129     uint32_t readable(void);
00130 
00131 
00137     uint32_t writeable(void);
00138 
00139 
00145     void flush(void);
00146 
00147 
00161     bool attach(serial_interrupt_callback_t func);
00162 
00163 
00173     bool write(const uint8_t* bytes, const uint32_t size = 1);
00174 
00175 
00185     bool read(uint8_t* bytes, const uint32_t size = 1);
00186 
00187 
00188 private:
00189     serial_avr32_conf_t         config_;            
00190     volatile avr32_usart_t*     uart_;              
00191     Buffer_T<1024>            tx_buffer_;         
00192     // Buffer                       rx_buffer_;         ///< Reception buffer
00193     Buffer_T<2048>            rx_buffer_;         
00194 
00195     static Serial_avr32*        handlers_[AVR32_SERIAL_MAX_NUMBER];     
00196 
00197 
00204     void irq_handler(void);
00205 
00206 
00212     serial_interrupt_callback_t irq_callback;
00213 
00214 
00222     static void irq0(void);
00223     static void irq1(void);
00224     static void irq2(void);
00225     static void irq3(void);
00226     static void irq4(void);
00227 };
00228 
00229 
00230 #endif /* SERIAL_AVR32_HPP_ */
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines