test public
Dependencies: HttpServer_snapshot_mbed-os
R_BSP_Ssif Class Reference
A class to communicate a R_BSP_Ssif. More...
#include <R_BSP_Ssif.h>
Inherits R_BSP_SerialFamily.
Public Member Functions | |
R_BSP_Ssif (PinName sck, PinName ws, PinName tx, PinName rx, PinName audio_clk=NC) | |
Constructor. | |
virtual | ~R_BSP_Ssif () |
Destructor. | |
void | init (const ssif_channel_cfg_t *const p_ch_cfg, int32_t max_write_num, int32_t max_read_num) |
Initialization. | |
int32_t | GetSsifChNo (void) |
Get a value of SSIF channel number. | |
bool | ConfigChannel (const ssif_channel_cfg_t *const p_ch_cfg) |
Save configuration to the SSIF driver. | |
bool | GetStatus (uint32_t *const p_status) |
Get a value of SSISR register. | |
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 | |
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_Ssif.
Definition at line 40 of file R_BSP_Ssif.h.
Constructor & Destructor Documentation
R_BSP_Ssif | ( | PinName | sck, |
PinName | ws, | ||
PinName | tx, | ||
PinName | rx, | ||
PinName | audio_clk = NC |
||
) |
Constructor.
- Parameters:
-
sck SSIF serial bit clock ws SSIF word selection tx SSIF serial data output rx SSIF serial data input
Definition at line 29 of file R_BSP_Ssif.cpp.
~R_BSP_Ssif | ( | ) | [virtual] |
Destructor.
Definition at line 38 of file R_BSP_Ssif.cpp.
Member Function Documentation
bool ConfigChannel | ( | const ssif_channel_cfg_t *const | p_ch_cfg ) |
Save configuration to the SSIF driver.
- Parameters:
-
p_ch_cfg SSIF channel configuration parameter
- Returns:
- true = success, false = failure
Definition at line 49 of file R_BSP_Ssif.cpp.
int32_t GetSsifChNo | ( | void | ) |
Get a value of SSIF channel number.
- Returns:
- SSIF channel number
Definition at line 72 of file R_BSP_Ssif.h.
bool GetStatus | ( | uint32_t *const | p_status ) |
Get a value of SSISR register.
- Parameters:
-
p_status Pointer of status value
- Returns:
- true = success, false = failure
Definition at line 53 of file R_BSP_Ssif.cpp.
void init | ( | const ssif_channel_cfg_t *const | p_ch_cfg, |
int32_t | max_write_num, | ||
int32_t | max_read_num | ||
) |
Initialization.
- Parameters:
-
p_ch_cfg SSIF channel configuration parameter max_write_num The upper limit of write buffer (SSIF) max_read_num The upper limit of read buffer (SSIF)
- Returns:
- true = success, false = failure
Definition at line 42 of file R_BSP_Ssif.cpp.
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, inherited] |
Channel init.
- Parameters:
-
function_list pointer of driver function callback table channel channel number config_data pointer of several parameters for a channel max_write_num The upper limit of write buffer max_read_num The upper limit of read buffer
Definition at line 47 of file R_BSP_SerialFamily.cpp.
bool ioctl | ( | int | request, |
... | |||
) | [inherited] |
Manipulates the underlying device parameters of special files.
- Parameters:
-
request has 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 101 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_data Location of the data. data_size Number of bytes to read. p_data_conf Asynchronous control block structure.
- Returns:
- Number of bytes read on success. negative number on error.
Definition at line 71 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:
-
handle channel handle. p_func_a Pointer of read function. max_buff_num The 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_data Location of the data. data_size Number of bytes to write. p_data_conf Asynchronous control block structure.
- Returns:
- Number of bytes written on success. negative number on error.
Definition at line 63 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:
-
handle channel handle. p_func_a Pointer of write function. max_buff_num The upper limit of write buffer.
Definition at line 91 of file R_BSP_Aio.h.
Generated on Wed Jul 13 2022 05:33:38 by 1.7.2