main_ubi_sdk v 0.1.3
This is UBI4 documentation
a_port.h File Reference
#include "UBI_SDK.h"
#include "stdint.h"
#include "stdbool.h"
Include dependency graph for a_port.h:
This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  port_struct
 
struct  base_port_struct
 

Typedefs

typedef uint8_t *(* get_tx_buffer_t) (void *init_str)
 
typedef uint8_t *(* get_rx_buffer_t) (void *init_str)
 
typedef void(* write_direct_t) (void *port_str, uint8_t *buf, uint16_t size)
 
typedef void(* write_and_time_receive_t) (void *port_str, uint8_t *buf, uint16_t size, uint32_t time_ms)
 
typedef int(* receive_data_t) (void *port_str)
 
typedef void(* base_port_receive_bridge_func_t) (void *port_str, uint8_t *buf, uint32_t size)
 
typedef void(* slave_answer_func_t) (void *port_str, uint8_t *buf, uint32_t size)
 
typedef void(* receive_to_current_device_func_t) (void *port_str, uint8_t *buf, uint32_t size)
 
typedef void(* receive_to_another_device_func_t) (void *port_str, uint8_t *buf, uint32_t size)
 
typedef void(* get_receive_buffer_size_t) (void *port_str, uint32_t *size)
 
typedef void(* read_data_buffer_t) (void *port_str, uint8_t *out_buf, uint32_t out_buf_size, uint32_t *read_bytes_size)
 
typedef void(* start_receive_task_t) (void *port_str)
 
typedef void(* processing_data_t) (void *port_str, uint32_t len)
 
typedef void(* wait_receive_t) (void *port_str, uint32_t rx_buf_offset, uint32_t len)
 
typedef void(* wait_tx_finish_t) (void *port_str)
 
typedef void(* wait_receive_time_t) (void *port, uint32_t time_ms)
 
typedef uint32_t(* wait_receive_time_blocked_t) (void *port, uint32_t offset, uint32_t len, uint32_t time_ms)
 
typedef void(* stop_receive_t) (void *port_str)
 
typedef void(* set_receiver_mode_t) (void *port_str, port_receive_mode_enum mode)
 
typedef uint32_t(* GetTransmitTime_us_t) (void *port_str, uint32_t num_bytes)
 
typedef void(* close_port_callback_t) (void *protocol_str)
 

Enumerations

enum  ports_enum {
  UBI_PE_ONE_WIRE_BUS = 0 , UBI_PE_UART_BUS , UBI_PE_SPI_BUS , UBI_PE_USB ,
  UPI_PE_BLE
}
 
enum  port_type_enum { UBI_PTE_FULL_DUPLEX = 0 , UBI_PTE_HALF_DUPLEX }
 
enum  port_receive_mode_enum { PORT_RECEIVER_IRQ_MODE = 0 , PORT_RECEIVER_COLLECT_MODE }
 

Functions

void base_port_init (base_port_struct *port_str)
 
void base_port_ubi4_bus_receive_data (base_port_struct *port_str)
 
void base_port_receive_bridge (base_port_struct *port_str, uint8_t *buf, uint32_t size)
 
void base_port_slave_answer (base_port_struct *port_str, uint8_t *buf, uint32_t size)
 
void base_port_receive_to_current_device (base_port_struct *port_str, uint8_t *buf, uint32_t size)
 
void base_port_get_receive_buffer_size (base_port_struct *port_str, uint32_t *size)
 
void base_port_read_data_buffer (base_port_struct *port_str, uint8_t *out_buf, uint32_t out_buf_size, uint32_t *read_bytes_size)
 
uint8_t * port_get_tx_buffer (base_port_struct *port_str)
 
uint8_t * port_get_rx_buffer (base_port_struct *port_str)
 

Typedef Documentation

◆ base_port_receive_bridge_func_t

typedef void(* base_port_receive_bridge_func_t) (void *port_str, uint8_t *buf, uint32_t size)

◆ close_port_callback_t

typedef void(* close_port_callback_t) (void *protocol_str)

◆ get_receive_buffer_size_t

typedef void(* get_receive_buffer_size_t) (void *port_str, uint32_t *size)

◆ get_rx_buffer_t

typedef uint8_t *(* get_rx_buffer_t) (void *init_str)

◆ get_tx_buffer_t

typedef uint8_t *(* get_tx_buffer_t) (void *init_str)

◆ GetTransmitTime_us_t

typedef uint32_t(* GetTransmitTime_us_t) (void *port_str, uint32_t num_bytes)

◆ processing_data_t

typedef void(* processing_data_t) (void *port_str, uint32_t len)

◆ read_data_buffer_t

typedef void(* read_data_buffer_t) (void *port_str, uint8_t *out_buf, uint32_t out_buf_size, uint32_t *read_bytes_size)

◆ receive_data_t

typedef int(* receive_data_t) (void *port_str)

◆ receive_to_another_device_func_t

typedef void(* receive_to_another_device_func_t) (void *port_str, uint8_t *buf, uint32_t size)

◆ receive_to_current_device_func_t

typedef void(* receive_to_current_device_func_t) (void *port_str, uint8_t *buf, uint32_t size)

◆ set_receiver_mode_t

typedef void(* set_receiver_mode_t) (void *port_str, port_receive_mode_enum mode)

◆ slave_answer_func_t

typedef void(* slave_answer_func_t) (void *port_str, uint8_t *buf, uint32_t size)

◆ start_receive_task_t

typedef void(* start_receive_task_t) (void *port_str)

◆ stop_receive_t

typedef void(* stop_receive_t) (void *port_str)

◆ wait_receive_t

typedef void(* wait_receive_t) (void *port_str, uint32_t rx_buf_offset, uint32_t len)

◆ wait_receive_time_blocked_t

typedef uint32_t(* wait_receive_time_blocked_t) (void *port, uint32_t offset, uint32_t len,uint32_t time_ms)

◆ wait_receive_time_t

typedef void(* wait_receive_time_t) (void *port, uint32_t time_ms)

◆ wait_tx_finish_t

typedef void(* wait_tx_finish_t) (void *port_str)

◆ write_and_time_receive_t

typedef void(* write_and_time_receive_t) (void *port_str, uint8_t *buf, uint16_t size, uint32_t time_ms)

◆ write_direct_t

typedef void(* write_direct_t) (void *port_str, uint8_t *buf, uint16_t size)

Enumeration Type Documentation

◆ port_receive_mode_enum

Enumerator
PORT_RECEIVER_IRQ_MODE 
PORT_RECEIVER_COLLECT_MODE 

◆ port_type_enum

Enumerator
UBI_PTE_FULL_DUPLEX 
UBI_PTE_HALF_DUPLEX 

◆ ports_enum

enum ports_enum
Enumerator
UBI_PE_ONE_WIRE_BUS 
UBI_PE_UART_BUS 
UBI_PE_SPI_BUS 
UBI_PE_USB 
UPI_PE_BLE 

Function Documentation

◆ base_port_get_receive_buffer_size()

void base_port_get_receive_buffer_size ( base_port_struct * port_str,
uint32_t * size )

◆ base_port_init()

void base_port_init ( base_port_struct * port_str)
Here is the call graph for this function:

◆ base_port_read_data_buffer()

void base_port_read_data_buffer ( base_port_struct * port_str,
uint8_t * out_buf,
uint32_t out_buf_size,
uint32_t * read_bytes_size )

◆ base_port_receive_bridge()

void base_port_receive_bridge ( base_port_struct * port_str,
uint8_t * buf,
uint32_t size )
Here is the caller graph for this function:

◆ base_port_receive_to_current_device()

void base_port_receive_to_current_device ( base_port_struct * port_str,
uint8_t * buf,
uint32_t size )
Here is the caller graph for this function:

◆ base_port_slave_answer()

void base_port_slave_answer ( base_port_struct * port_str,
uint8_t * buf,
uint32_t size )
Here is the caller graph for this function:

◆ base_port_ubi4_bus_receive_data()

void base_port_ubi4_bus_receive_data ( base_port_struct * port_str)

◆ port_get_rx_buffer()

uint8_t * port_get_rx_buffer ( base_port_struct * port_str)
Here is the caller graph for this function:

◆ port_get_tx_buffer()

uint8_t * port_get_tx_buffer ( base_port_struct * port_str)
Here is the caller graph for this function: