Renesas / R_BSP Featured

RZ/A1H CMSIS-RTOS RTX BSP for GR-PEACH.

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

scux.c File Reference
Functions

scux.c File Reference

SCUX Driver functions. More...

Go to the source code of this file.

Functions

static int_t SCUX_CheckSrcParam (scux_info_ch_t *const p_scux_info_ch, const uint32_t ssif_ch[SCUX_SSIF_NUM_CH_ARRANGEMENT])
 Function Name: SCUX_CheckSrcParam.
static int_t SCUX_CheckDvuParam (const scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_CheckDvuParam.
static int_t SCUX_CheckSsifParam (scux_info_ch_t *const p_scux_info_ch, const uint32_t ssif_ch[SCUX_SSIF_NUM_CH_ARRANGEMENT], const bool_t use_mix_flag)
 Function Name: SCUX_CheckSsifParam.
static int_t SCUX_CheckMixParam (const scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_CheckMixParam.
static int_t SCUX_CmnUnInitialize (void)
 Function Name: SCUX_CmnUnInitialize.
scux_info_drv_t * SCUX_GetDrvInstance (void)
 Function Name: SCUX_GetDrvInstance.
scux_info_ch_t * SCUX_GetDrvChInfo (const int_t channel)
 Function Name: SCUX_GetDrvChInfo.
scux_ssif_info_t * SCUX_GetSsifChInfo (const int_t channel)
 Function Name: SCUX_GetSsifChInfo.
int_t SCUX_InitializeOne (const int_t channel, const scux_channel_cfg_t *const p_scux_init_param)
 Function Name: SCUX_InitializeOne.
void SCUX_UnInitializeOne (const int_t channel)
 Function Name: SCUX_UnInitializeOne.
int_t SCUX_Initialize (const scux_channel_cfg_t *const p_scux_init_param)
 Function Name: SCUX_Initialize.
void SCUX_UnInitialize (void)
 Function Name: SCUX_UnInitialize.
int_t SCUX_OpenChannel (const int_t channel, const int_t flags)
 Function Name: SCUX_OpenChannel.
int_t SCUX_CloseChannel (const int_t channel)
 Function Name: SCUX_CloseChannel.
int_t SCUX_CheckParam (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_CheckParam.
size_t SCUX_StrNLen (const char_t *p_str, size_t maxlen)
 Function Name: SCUX_StrNLen.

Detailed Description

SCUX Driver functions.

Rev:
1674
Date:
2015-05-29 16:35:57 +0900#

Definition in file scux.c.

Function Documentation

static int_t SCUX_CheckDvuParam ( const scux_info_ch_t *const   p_scux_info_ch ) [static]

Function Name: SCUX_CheckDvuParam.

Check DVU parameter.

Description:

Parameters:
[in]*p_scux_info_ch:SCUXchannel information.
Return values:
ESUCCESS: Parameter is no problems. EACCES : DVU setting isn't performed when DVU is used. EPERM : Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 2385 of file scux.c.

static int_t SCUX_CheckMixParam ( const scux_info_ch_t *const   p_scux_info_ch ) [static]

Function Name: SCUX_CheckMixParam.

Check MIX parameter.

Description:

Parameters:
[in]*p_scux_info_ch:SCUXchannel information.
Return values:
ESUCCESS: Parameter is no problems. EACCES : MIX setting isn't performed when MIX is used. EPERM : Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 2659 of file scux.c.

int_t SCUX_CheckParam ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_CheckParam.

Check SCUX parameter.

Description:

Parameters:
[in]*p_scux_info_ch:SCUXchannel information.
Return values:
ESUCCESS: Parameter is no problems. EACCES : DVU setting isn't performed when DVU is used. EACCES : MIX setting isn't performed when MIX is used. EACCES : SSIF setting isn't performed when SSIF is used. EPERM : Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 1502 of file scux.c.

static int_t SCUX_CheckSrcParam ( scux_info_ch_t *const   p_scux_info_ch,
const uint32_t  ssif_ch[SCUX_SSIF_NUM_CH_ARRANGEMENT] 
) [static]

Function Name: SCUX_CheckSrcParam.

Check SRC parameter and set rate parameter to SCUX information.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
[in]ssif_ch: Used ssif channel number.
[in]use_mix_flag: Flag of Using MIX .
Return values:
ESUCCESS: Parameter is no problems. EPERM : Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 1821 of file scux.c.

static int_t SCUX_CheckSsifParam ( scux_info_ch_t *const   p_scux_info_ch,
const uint32_t  ssif_ch[SCUX_SSIF_NUM_CH_ARRANGEMENT],
const bool_t  use_mix_flag 
) [static]

Function Name: SCUX_CheckSsifParam.

Check SSIF parameter.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
[in]ssif_ch: Used ssif channel number.
[in]use_mix_flag: Flag of Using MIX .
Return values:
ESUCCESS: Parameter is no problems. EACCES : SSIF setting isn't performed when SSIF is used. EACCES : SSIF channel is already used. EACCES : When use MIX, it is a setup which does not agree in a route setup. EPERM : Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 2489 of file scux.c.

int_t SCUX_CloseChannel ( const int_t  channel )

Function Name: SCUX_CloseChannel.

Close SCUX driver channel.

Description:

Parameters:
[in]channel,:SCUX channel number.
Return values:
ESUCCESS: Operation successful. EFAULT : Internal error is occured.

Definition at line 1430 of file scux.c.

static int_t SCUX_CmnUnInitialize ( void   ) [static]

Function Name: SCUX_CmnUnInitialize.

uninitialize driver infomation.

Description:

Parameters:
[in]None.
Return values:
ESUCCESS: Parameter is no problems. EFAULT : Internal error is occured.

Definition at line 2776 of file scux.c.

scux_info_ch_t* SCUX_GetDrvChInfo ( const int_t  channel )

Function Name: SCUX_GetDrvChInfo.

gb_scux_info_drv.info_ch[channel].

Description:

Parameters:
[in]channelinformation number.
Return values:
pointerof gb_scux_info_drv - pointer of channel information.

Definition at line 300 of file scux.c.

scux_info_drv_t* SCUX_GetDrvInstance ( void   )

Function Name: SCUX_GetDrvInstance.

Get pointer of gb_scux_info_drv.

Description:

Parameters:
None.
Return values:
pointerof gb_scux_info_drv - driver instance.

Definition at line 279 of file scux.c.

scux_ssif_info_t* SCUX_GetSsifChInfo ( const int_t  channel )

Function Name: SCUX_GetSsifChInfo.

gb_scux_ssif_info.channel.

Description:

Parameters:
[in]SSIFchannel number.
Return values:
pointerof gb_scux_ssif_info - pointer of SSIF information.

Definition at line 321 of file scux.c.

int_t SCUX_Initialize ( const scux_channel_cfg_t *const   p_scux_init_param )

Function Name: SCUX_Initialize.

Init SCUX driver.

Description:

Parameters:
[in]p_scux_init_param:Initialize parameter for SCUX.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured. error code - ENOMEM : Making semaphore is failed. EFAULT : Internal error is occured.

Definition at line 899 of file scux.c.

int_t SCUX_InitializeOne ( const int_t  channel,
const scux_channel_cfg_t *const   p_scux_init_param 
)

Function Name: SCUX_InitializeOne.

Init SCUX driver.

Description:

Parameters:
[in]channel:initialize channel number.
[in]p_scux_init_param:Initialize parameter for SCUX.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured. error code - ENOMEM : Making semaphore is failed. EFAULT : Internal error is occured.

Definition at line 348 of file scux.c.

int_t SCUX_OpenChannel ( const int_t  channel,
const int_t  flags 
)

Function Name: SCUX_OpenChannel.

Open SCUX driver channel.

Description:

Parameters:
[in]channel:openchannel number.
[in]flags:specifiesthe access mode whether the channel is opened for a read or a write
Return values:
ESUCCESS,:Operation successful. ENOMEM: Create queue is failed. EMFILE: Allocate DMA ch for write is failed.

Definition at line 1362 of file scux.c.

size_t SCUX_StrNLen ( const char_t *  p_str,
size_t  maxlen 
)

Function Name: SCUX_StrNLen.

computes the length of the string

Description:
if string is longer than maxlen, this function return maxlen

Parameters:
[in]p_str:pointer of string
[in]maxlen:maximum length of inspection
Return values:
'numberof characters in the string' or 'maxlen'

Definition at line 2739 of file scux.c.

void SCUX_UnInitialize ( void   )

Function Name: SCUX_UnInitialize.

Uninit SCUX driver.

Description:

Parameters:
[in]None.
Return values:
None.

Definition at line 1210 of file scux.c.

void SCUX_UnInitializeOne ( const int_t  channel )

Function Name: SCUX_UnInitializeOne.

Uninit SCUX driver.

Description:

Parameters:
[in]channel:unInitialize channel number.
Return values:
None.

Definition at line 739 of file scux.c.

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