/home/travis/build/lis-epfl/MAVRIC_Library/hal/stm32/serial_usb_stm32.hpp

/*******************************************************************************
 * Copyright (c) 2009-2016, MAV'RIC Development Team
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of the copyright holder nor the names of its contributors
 * may be used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 ******************************************************************************/

/*******************************************************************************
 * \file    serial_usb_stm32.hpp
 *
 * \author  MAV'RIC Team
 *
 * \brief   Implementation of serial over USB for stm32
 *
 * \details Incomplete implementation (TODO)
 *          - Implemented:
 *              * buffered, blocking writing
 *              * Read functions
 *              * Receive interrupt callback
 *          - NOT implemented:
 *              * buffered input
 *
 ******************************************************************************/

#ifndef SERIAL_USB_STM32_HPP_
#define SERIAL_USB_STM32_HPP_

#include "hal/common/serial.hpp"
#include "util/buffer.hpp"


class Serial_usb_stm32: public Serial
{
public:
    struct conf_t
    {
        bool enable_vbus_detection;     
    };


    Serial_usb_stm32(const conf_t config = default_config());


    static inline conf_t default_config(void);


    bool init(void);


    uint32_t readable(void);


    uint32_t writeable(void);


    void flush(void);


    bool attach(serial_interrupt_callback_t func);


    bool write(const uint8_t* bytes, const uint32_t size = 1);


    bool read(uint8_t* bytes, const uint32_t size = 1);

    static void irq(void);

private:
    conf_t                      config_;        
    Buffer_T<1024>            tx_buffer_;     
    Buffer_T<1024>            rx_buffer_;     

    static Serial_usb_stm32* instance_;         
    serial_interrupt_callback_t irq_callback;   

    void irq_handler(void);
};


Serial_usb_stm32::conf_t Serial_usb_stm32::default_config()
{
    Serial_usb_stm32::conf_t conf = {};

    // Disable VBUS detection by default
    conf.enable_vbus_detection = false;

    return conf;
}

#endif /* SERIAL_USB_STM32_HPP_ */