MAV'RIC
/home/travis/build/lis-epfl/MAVRIC_Library/hal/linux/serial_linux_io.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_usb_linux_io.hpp
00034  *
00035  * \author  MAV'RIC Team
00036  *
00037  * \brief   Implementation of serial wrapping around iostream (std::cout and std::cin)
00038  *
00039  * \details write(...) writes to std::cout    read(...) reads from std::cin
00040  *
00041  ******************************************************************************/
00042 
00043 #ifndef SERIAL_LINUX_IO_HPP_
00044 #define SERIAL_LINUX_IO_HPP_
00045 
00046 #include "hal/common/serial.hpp"
00047 
00048 
00052 typedef struct
00053 {
00054     //std::ostream& stream;
00055 } serial_linux_io_conf_t;
00056 
00062 static inline serial_linux_io_conf_t serial_linux_io_default_config();
00063 
00067 class Serial_linux_io: public Serial
00068 {
00069 public:
00070 
00076     Serial_linux_io(serial_linux_io_conf_t config = serial_linux_io_default_config());
00077 
00078 
00085     bool init(void);
00086 
00087 
00093     uint32_t readable(void);
00094 
00095 
00101     uint32_t writeable(void);
00102 
00103 
00109     void flush(void);
00110 
00111 
00125     bool attach(serial_interrupt_callback_t func);
00126 
00127 
00137     bool write(const uint8_t* bytes, const uint32_t size = 1);
00138 
00139 
00149     bool read(uint8_t* bytes, const uint32_t size = 1);
00150 
00151 
00157     bool newline();
00158 
00159 private:
00160     serial_linux_io_conf_t config_;
00161 };
00162 
00168 static inline serial_linux_io_conf_t serial_linux_io_default_config()
00169 {
00170     serial_linux_io_conf_t conf = {};
00171     return conf;
00172 }
00173 
00174 #endif /* SERIAL_LINUX_IO_HPP_ */
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines