Renesas / R_BSP Featured

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   GR-PEACH_Azure_Speech ImageZoomInout_Sample ImageRotaion_Sample ImageScroll_Sample ... more

Fork of R_BSP by Daiki Kato

Embed: (wiki syntax)

« Back to documentation index

R_BSP_SerialFamily Class Reference
Public Member Functions | Protected Member Functions

R_BSP_SerialFamily Class Reference

A class to communicate a R_BSP_SerialFamily. More...

#include <R_BSP_SerialFamily.h>

Inherits R_BSP_Aio.

Inherited by R_BSP_Scux, and R_BSP_Ssif.

Public Member Functions

bool ioctl (int request,...)
 Manipulates the underlying device parameters of special files.
int32_t write (void *const p_data, uint32_t data_size, const rbsp_data_conf_t *const p_data_conf=NULL)
 Write count bytes to the file associated.
int32_t read (void *const p_data, uint32_t data_size, const rbsp_data_conf_t *const p_data_conf=NULL)
 Read count bytes to the file associated.

Protected Member Functions

virtual ~R_BSP_SerialFamily ()
 Destructor.
bool init_channel (RBSP_MBED_FNS *function_list, int channel, void *const config_data, int32_t max_write_num=16, int32_t max_read_num=16)
 Channel init.
void write_init (void *handle, void *p_func_a, int32_t max_buff_num=16)
 Write init.
void read_init (void *handle, void *p_func_a, int32_t max_buff_num=16)
 Read init.

Detailed Description

A class to communicate a R_BSP_SerialFamily.

Definition at line 40 of file R_BSP_SerialFamily.h.

Constructor & Destructor Documentation

~R_BSP_SerialFamily (  ) [protected, virtual]

Destructor.

Definition at line 36 of file R_BSP_SerialFamily.cpp.

Member Function Documentation

bool init_channel ( RBSP_MBED_FNS *  function_list,
int  channel,
void *const   config_data,
int32_t  max_write_num = 16,
int32_t  max_read_num = 16 
) [protected]

Channel init.

Parameters:
function_listpointer of driver function callback table
channelchannel number
config_datapointer of several parameters for a channel
max_write_numThe upper limit of write buffer
max_read_numThe upper limit of read buffer

Definition at line 47 of file R_BSP_SerialFamily.cpp.

bool ioctl ( int  request,
  ... 
)

Manipulates the underlying device parameters of special files.

Parameters:
requesthas encoded in it whether the argument is an "in" parameter or "out" parameter, and the size of the argument argp in bytes.
Returns:
true = success, false = failure

Definition at line 90 of file R_BSP_SerialFamily.cpp.

int32_t read ( void *const   p_data,
uint32_t  data_size,
const rbsp_data_conf_t *const   p_data_conf = NULL 
) [inherited]

Read count bytes to the file associated.

Parameters:
p_dataLocation of the data.
data_sizeNumber of bytes to read.
p_data_confAsynchronous control block structure.
Returns:
Number of bytes read on success. negative number on error.

Definition at line 72 of file R_BSP_Aio.cpp.

void read_init ( void *  handle,
void *  p_func_a,
int32_t  max_buff_num = 16 
) [protected, inherited]

Read init.

Parameters:
handlechannel handle.
p_func_aPointer of read function.
max_buff_numThe upper limit of read buffer.

Definition at line 101 of file R_BSP_Aio.h.

int32_t write ( void *const   p_data,
uint32_t  data_size,
const rbsp_data_conf_t *const   p_data_conf = NULL 
) [inherited]

Write count bytes to the file associated.

Parameters:
p_dataLocation of the data.
data_sizeNumber of bytes to write.
p_data_confAsynchronous control block structure.
Returns:
Number of bytes written on success. negative number on error.

Definition at line 64 of file R_BSP_Aio.cpp.

void write_init ( void *  handle,
void *  p_func_a,
int32_t  max_buff_num = 16 
) [protected, inherited]

Write init.

Parameters:
handlechannel handle.
p_func_aPointer of write function.
max_buff_numThe upper limit of write buffer.

Definition at line 91 of file R_BSP_Aio.h.

Generated on Tue Jul 12 2022 20:43:59 by  doxygen 1.7.2