OU_FILE_BUF Struct Reference

#include <oulib.h>

List of all members.

Public Attributes
uint8_t	port
uint8_t	buf_size_in
uint8_t	buf_size_out
volatile uint8_t	buf_in_front
volatile uint8_t	buf_in_back
volatile uint8_t	buf_out_front
volatile uint8_t	buf_out_back
char *	buffer

---

Detailed Description

struct OU_FILE_BUF

File pointer structure for buffered serial ports.

---

Member Data Documentation

volatile uint8_t OU_FILE_BUF::buf_in_back

Index of the back of the input buffer (index of the next char spot).

Referenced by serial_buffered_input_nbytes(), serial_buffered_input_waiting(), serial_init_buffered(), serial_receive_isr(), and uart_recv_general_buffered().

volatile uint8_t OU_FILE_BUF::buf_in_front

Index of the front of the input buffer.

Referenced by serial_buffered_input_nbytes(), serial_buffered_input_waiting(), serial_init_buffered(), serial_receive_isr(), and uart_recv_general_buffered().

volatile uint8_t OU_FILE_BUF::buf_out_back

Index of the back of the output buffer (index of the next char spot).

Referenced by serial_buffered_output_free(), serial_init_buffered(), serial_transmit_isr(), and uart_send_general_buffered().

volatile uint8_t OU_FILE_BUF::buf_out_front

Index of the front of the output buffer.

Referenced by serial_buffered_output_free(), serial_init_buffered(), serial_transmit_isr(), and uart_send_general_buffered().

uint8_t OU_FILE_BUF::buf_size_in

Number of bytes in input buffer.

Referenced by serial_buffered_input_nbytes(), serial_init_buffered(), serial_receive_isr(), serial_transmit_isr(), uart_recv_general_buffered(), and uart_send_general_buffered().

uint8_t OU_FILE_BUF::buf_size_out

Number of bytes in output buffer.

Referenced by serial_buffered_output_free(), serial_init_buffered(), serial_transmit_isr(), and uart_send_general_buffered().

char* OU_FILE_BUF::buffer

Reference to the buffer space.

Referenced by serial_init_buffered(), serial_receive_isr(), serial_transmit_isr(), uart_recv_general_buffered(), and uart_send_general_buffered().

uint8_t OU_FILE_BUF::port

Reference to physical serial port. 0 .. 3, depending on hardware

Referenced by serial_init_buffered(), serial_receive_isr(), serial_transmit_isr(), and uart_send_general_buffered().

---

The documentation for this struct was generated from the following file:

• include/oulib.h