MAV'RIC
/home/travis/build/lis-epfl/MAVRIC_Library/hal/linux/serial_udp.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_udp.hpp
00034  *
00035  * \author  MAV'RIC Team
00036  *
00037  * \brief   Linux implementation of serial peripherals using UDP
00038  *
00039  ******************************************************************************/
00040 
00041 #ifndef SERIAL_UDP_HPP_
00042 #define SERIAL_UDP_HPP_
00043 
00044 #include "hal/common/serial.hpp"
00045 #include "util/buffer.hpp"
00046 
00047 extern "C"
00048 {
00049 #include <cstdint>
00050 #include <sys/socket.h>
00051 #include <arpa/inet.h>
00052 }
00053 
00057 typedef struct
00058 {
00059     const char* target_ip;
00060     int32_t     target_port;
00061     int32_t     local_port;
00062 } serial_udp_conf_t;
00063 
00064 
00070 static inline serial_udp_conf_t serial_udp_default_config();
00071 
00072 
00073 class Serial_udp: public Serial
00074 {
00075 public:
00081     Serial_udp(serial_udp_conf_t config = serial_udp_default_config());
00082 
00083 
00090     bool init(void);
00091 
00092 
00098     uint32_t readable(void);
00099 
00100 
00106     uint32_t writeable(void);
00107 
00108 
00114     void flush(void);
00115 
00116 
00130     bool attach(serial_interrupt_callback_t func);
00131 
00132 
00142     bool write(const uint8_t* bytes, const uint32_t size = 1);
00143 
00144 
00154     bool read(uint8_t* bytes, const uint32_t size = 1);
00155 
00156 
00157 private:
00158     serial_udp_conf_t   config_;
00159 
00160     Buffer_T<1024>    tx_buffer_;
00161     Buffer              rx_buffer_;
00162 
00163     int                 socket_;
00164     struct sockaddr_in  target_addr_;
00165     struct sockaddr_in  local_addr_;
00166 };
00167 
00168 
00174 static inline serial_udp_conf_t serial_udp_default_config()
00175 {
00176     serial_udp_conf_t   conf;
00177 
00178     conf.target_ip      = "127.0.0.1";
00179     conf.target_port    = 14550;
00180     conf.local_port     = 14000;
00181 
00182     return conf;
00183 }
00184 
00185 
00186 #endif /* SERIAL_UDP_HPP_ */
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines