serial.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017, James Jackson
3  *
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions are met:
8  *
9  * * Redistributions of source code must retain the above copyright notice, this
10  * list of conditions and the following disclaimer.
11  *
12  * * Redistributions in binary form must reproduce the above copyright notice,
13  * this list of conditions and the following disclaimer in the documentation
14  * and/or other materials provided with the distribution.
15  *
16  * * Neither the name of the copyright holder nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23  * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31 
32 #ifndef SERIAL_CLASS_H
33 #define SERIAL_CLASS_H
34 
35 #include "gpio.h"
36 
37 #include <stdint.h>
38 
39 #include <functional>
40 
41 #define RX_BUFFER_SIZE 512
42 #define TX_BUFFER_SIZE 512
43 
44 class Serial
45 {
46 public:
47  enum
48  {
49  POLLING = 0x00,
50  INTERRUPT = 0x01,
51  DMA_TX = 0x02,
52  DMA_RX = 0x04
53  };
54 
55  enum
56  {
57  UART = 0,
58  VCP = 1
59  };
60  Serial() {}
61  virtual void write(const uint8_t* ch, uint8_t len) = 0;
62  virtual uint32_t rx_bytes_waiting() = 0;
63  virtual uint32_t tx_bytes_free() = 0;
64  virtual uint8_t read_byte() = 0;
65  virtual bool tx_buffer_empty() = 0;
66  virtual void put_byte(uint8_t ch) = 0;
67  virtual bool flush() = 0;
68  virtual void register_rx_callback(void (*cb)(uint8_t data)) = 0;
69  virtual void unregister_rx_callback() = 0;
70 
71 protected:
74 
75  uint8_t mode_;
76 
77  std::function<void(uint8_t)> receive_CB_ = nullptr;
78 };
79 
80 #endif // SERIAL CLASS_H
virtual bool tx_buffer_empty()=0
Serial()
Definition: serial.h:60
virtual bool flush()=0
std::function< void(uint8_t)> receive_CB_
Definition: serial.h:77
virtual uint8_t read_byte()=0
GPIO tx_pin_
Definition: serial.h:72
virtual void put_byte(uint8_t ch)=0
Definition: uart.h:42
Definition: vcp.h:19
GPIO rx_pin_
Definition: serial.h:73
uint8_t mode_
Definition: serial.h:75
Definition: serial.h:44
Definition: gpio.h:37
void cb(uint8_t byte)
Definition: ublox.cpp:8
virtual void write(const uint8_t *ch, uint8_t len)=0
virtual void unregister_rx_callback()=0
virtual uint32_t rx_bytes_waiting()=0
virtual void register_rx_callback(void(*cb)(uint8_t data))=0
virtual uint32_t tx_bytes_free()=0


rosflight_firmware
Author(s): Daniel Koch , James Jackson
autogenerated on Sat May 9 2020 03:16:53