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

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

Fork of R_BSP by Daiki Kato

Embed: (wiki syntax)

« Back to documentation index

scux.h File Reference

scux.h File Reference

Sample driver internal header. More...

Go to the source code of this file.

Functions

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_IoctlTransStart (const int_t channel)
 Function Name: SCUX_IoctlTransStart.
int_t SCUX_IoctlClearStop (const int_t channel, const int_t was_masked)
 Function Name: SCUX_IoctlClearStop.
void SCUX_IoctlSetRoute (const int_t channel, const scux_route_t route)
 Function Name: SCUX_IoctlSetRoute.
int_t SCUX_IoctlSetPinClk (const int_t channel, const scux_ssif_pin_clk_t *const p_pin_clk_param)
 Function Name: SCUX_IoctlSetPinClk.
int_t SCUX_IoctlSetPinMode (const int_t channel, const scux_ssif_pin_mode_t *const p_pin_mode_param)
 Function Name: SCUX_IoctlSetPinMode.
void SCUX_IoctlSetSrcCfg (const int_t channel, const scux_src_cfg_t *const p_src_param)
 Function Name: SCUX_IoctlSetSrcCfg.
void SCUX_IoctlSetDvuCfg (const int_t channel, const scux_dvu_cfg_t *const p_dvu_param)
 Function Name: SCUX_IoctlSetDvuCfg.
int_t SCUX_IoctlSetDvuDigiVol (const int_t channel, const scux_dvu_digi_vol_t *const p_digi_vol_param)
 Function Name: SCUX_IoctlSetDvuDigiVol.
int_t SCUX_IoctlSetDvuRampVol (const int_t channel, const scux_dvu_ramp_vol_t *const p_ramp_vol_param)
 Function Name: SCUX_IoctlSetDvuRampVol.
int_t SCUX_IoctlSetDvuZerocrossMute (const int_t channel, const scux_zc_mute_t *const p_zc_mute_param)
 Function Name: SCUX_IoctlSetDvuZerocrossMute.
int_t SCUX_IoctlSetStopMute (const int_t channel, const uint32_t audio_channel)
 Function Name: SCUX_IoctlSetStopMute.
int_t SCUX_IoctlSetMixCfg (const scux_mix_cfg_t *const p_mix_param)
 Function Name: SCUX_IoctlSetMixCfg.
int_t SCUX_IoctlSetMixVol (const int_t channel, const uint32_t mix_vol)
 Function Name: SCUX_IoctlSetMixVol.
int_t SCUX_IoctlSetSsifCfg (const scux_ssif_cfg_t *const p_ssif_param)
 Function Name: SCUX_IoctlSetSsifCfg.
void SCUX_IoctlGetWriteStat (const int_t channel, uint32_t *const p_write_stat)
 Function Name: SCUX_IoctlGetWriteStat.
void SCUX_IoctlGetReadStat (const int_t channel, uint32_t *const p_read_stat)
 Function Name: SCUX_IoctlGetReadStat.
void SCUX_IoctlGetDvuStat (const int_t channel, uint32_t *const p_dvu_stat)
 Function Name: SCUX_IoctlGetDvuStat.
void SCUX_IoctlGetMuteStat (const int_t channel, uint32_t *const p_mute_stat)
 Function Name: SCUX_IoctlGetMuteStat.
void SCUX_IoctlGetMixStat (const int_t channel, uint32_t *const p_mix_stat)
 Function Name: SCUX_IoctlGetMixStat.
int_t SCUX_CheckParam (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_CheckParam.
int_t SCUX_FlushWriteStart (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_FlushWriteStart.
void SCUX_InitHw (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_InitHw.
void SCUX_SetupSsif (const scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SetupSsif.
void SCUX_SetupSrc (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SetupSrc.
void SCUX_SetupDvu (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SetupDvu.
int_t SCUX_SetupDma (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SetupDma.
void SCUX_SyncStartHw (const scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SyncStartHw.
void SCUX_AsyncStartHw (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_AsyncStartHw.
int_t SCUX_CopyWriteStart (scux_info_ch_t *const p_scux_info_ch, AIOCB *const p_write_aio)
 Function Name: SCUX_CopyWriteStart.
int_t SCUX_DirectWriteStart (scux_info_ch_t *const p_scux_info_ch, AIOCB *const p_write_aio)
 Function Name: SCUX_DirectWriteStart.
int_t SCUX_CopyReadStart (scux_info_ch_t *const p_scux_info_ch, AIOCB *const p_read_aio)
 Function Name: SCUX_CopyReadStart.
int_t SCUX_CopyCancelSpecific (scux_info_ch_t *const p_scux_info_ch, AIOCB *const p_cancel_aio)
 Function Name: SCUX_CopyCancelSpecific.
int_t SCUX_DirectCancelSpecific (scux_info_ch_t *const p_scux_info_ch, AIOCB *const p_cancel_aio)
 Function Name: SCUX_DirectCancelSpecific.
int_t SCUX_CopyCancelAll (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_CopyCancelAll.
int_t SCUX_DirectCancelAll (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_DirectCancelAll.
void SCUX_AdjustAccessFifo (scux_info_ch_t *const p_scux_info_ch, const uint32_t tx_remain_size, const uint32_t rx_remain_size)
 Function Name: SCUX_AdjustAccessFifo.
void SCUX_SyncStopHw (const scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SyncStopHw.
void SCUX_AsyncStopHw (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_AsyncStopHw.
void SCUX_SetDigiVolRegister (const scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SetDigiVolRegister.
void SCUX_SetRampVolRegister (scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SetRampVolRegister.
void SCUX_SetZerocrossMuteRegister (const scux_info_ch_t *const p_scux_info_ch)
 Function Name: SCUX_SetZerocrossMuteRegister.
void SCUX_SetMixVolRegister (const int_t channel)
 Function Name: SCUX_SetMixVolRegister.
int_t SCUX_CheckSsifClockDiv (const scux_info_ch_t *const p_scux_info_ch, const uint32_t ssif_ch_num)
 Function Name: SCUX_CheckSsifClockDiv.
void SCUX_SetupSsifGpio (const scux_ssif_ch_num_t ssif_ch)
 Function Name: SCUX_SetupSsifGpio.
size_t SCUX_StrNLen (const char_t *p_str, size_t maxlen)
 Function Name: SCUX_StrNLen.

Detailed Description

Sample driver internal header.

Rev:
993
Date:
2014-07-22 09:54:45 +0900#

Definition in file scux.h.


Function Documentation

void SCUX_AdjustAccessFifo ( scux_info_ch_t *const   p_scux_info_ch,
const uint32_t  tx_remain_size,
const uint32_t  rx_remain_size 
)

Function Name: SCUX_AdjustAccessFifo.

Fifo is Cleared.

Description:

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

Definition at line 965 of file scux_dev.c.

void SCUX_AsyncStartHw ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_AsyncStartHw.

Start Hw on async mode.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 3140 of file scux_dev.c.

void SCUX_AsyncStopHw ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_AsyncStopHw.

Stop Hw on async mode.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 3290 of file scux_dev.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.

int_t SCUX_CheckSsifClockDiv ( const scux_info_ch_t *const   p_scux_info_ch,
const uint32_t  ssif_ch_num 
)

Function Name: SCUX_CheckSsifClockDiv.

Check SSIF clock divide rate.

Description:

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

Definition at line 54 of file scux_board.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.

int_t SCUX_CopyCancelAll ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_CopyCancelAll.

Cancel all request(mem->mem).

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
ESUCCESS: Operation successful. EFAULT : Internal error is occured.

Definition at line 750 of file scux_dev.c.

int_t SCUX_CopyCancelSpecific ( scux_info_ch_t *const   p_scux_info_ch,
AIOCB *const   p_cancel_aio 
)

Function Name: SCUX_CopyCancelSpecific.

Cancel specific request(mem->mem).

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
[in]*p_cancel_aio: Cancel request information.
Return values:
ESUCCESS: Operation successful. EBUSY : Cancel requst is on going. EFAULT : Internal error is occured.

Definition at line 619 of file scux_dev.c.

int_t SCUX_CopyReadStart ( scux_info_ch_t *const   p_scux_info_ch,
AIOCB *const   p_read_aio 
)

Function Name: SCUX_CopyReadStart.

Start read request(mem -> mem).

Description:

Parameters:
[in]*p_scux_info_ch:SCUXchannel information.
[in]*p_read_aio:Readrequest information.
Return values:
ESUCCESS: Operation successful. EFAULT : Internal error is occured.

Definition at line 393 of file scux_dev.c.

int_t SCUX_CopyWriteStart ( scux_info_ch_t *const   p_scux_info_ch,
AIOCB *const   p_write_aio 
)

Function Name: SCUX_CopyWriteStart.

Start write request (mem->mem).

Description:

Parameters:
[in]*p_scux_info_ch:SCUXchannel information.
[in]*p_write_aio:Writerequest information.
Return values:
ESUCCESS: Operation successful. EFAULT : Internal error is occured.

Definition at line 115 of file scux_dev.c.

int_t SCUX_DirectCancelAll ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_DirectCancelAll.

Cancel all request(SSIF direct route).

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
ESUCCESS: Operation successful. EFAULT : Internal error is occured.

Definition at line 868 of file scux_dev.c.

int_t SCUX_DirectCancelSpecific ( scux_info_ch_t *const   p_scux_info_ch,
AIOCB *const   p_cancel_aio 
)

Function Name: SCUX_DirectCancelSpecific.

Cancel specific request(SSIF direct route).

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
[in]*p_cancel_aio: Cancel request information.
Return values:
ESUCCESS: Operation successful. EBUSY : Cancel requst is on going. EFAULT : Internal error is occured.

Definition at line 688 of file scux_dev.c.

int_t SCUX_DirectWriteStart ( scux_info_ch_t *const   p_scux_info_ch,
AIOCB *const   p_write_aio 
)

Function Name: SCUX_DirectWriteStart.

Start write request(SSIF direct route).

Description:

Parameters:
[in]*p_scux_info_ch:SCUXchannel information.
[in]*p_write_aio:Writerequest information.
Return values:
ESUCCESS: Operation successful. EFAULT : Internal error is occured.

Definition at line 234 of file scux_dev.c.

int_t SCUX_FlushWriteStart ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_FlushWriteStart.

Start dummy write for FIFO flush.

Description:

Parameters:
[in]*p_scux_info_ch:SCUXchannel information.
[in]*p_write_aio:Writerequest information.
Return values:
ESUCCESS: Operation successful. EFAULT : Internal error is occured.

Definition at line 518 of file scux_dev.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.

void SCUX_InitHw ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_InitHw.

Initialize HW .

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 2922 of file scux_dev.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_IoctlClearStop ( const int_t  channel,
const int_t  was_masked 
)

Function Name: SCUX_IoctlClearStop.

Set flush stop paramter.

Description:

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

Definition at line 1197 of file scux_ioctl.c.

void SCUX_IoctlGetDvuStat ( const int_t  channel,
uint32_t *const   p_dvu_stat 
)

Function Name: SCUX_IoctlGetDvuStat.

Get DVU status.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_dvu_stat:DVUstatus.
Return values:
None.

Definition at line 2490 of file scux_ioctl.c.

void SCUX_IoctlGetMixStat ( const int_t  channel,
uint32_t *const   p_mix_stat 
)

Function Name: SCUX_IoctlGetMixStat.

Get MIX status.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_mix_stat:MIXstatus.
Return values:
None.

Definition at line 2564 of file scux_ioctl.c.

void SCUX_IoctlGetMuteStat ( const int_t  channel,
uint32_t *const   p_mute_stat 
)

Function Name: SCUX_IoctlGetMuteStat.

Get MUTE status.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_mute_stat:MUTEstatus.
Return values:
None.

Definition at line 2521 of file scux_ioctl.c.

void SCUX_IoctlGetReadStat ( const int_t  channel,
uint32_t *const   p_read_stat 
)

Function Name: SCUX_IoctlGetReadStat.

Get read request status.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_read_stat:Readrequest status.
Return values:
None.

Definition at line 2434 of file scux_ioctl.c.

void SCUX_IoctlGetWriteStat ( const int_t  channel,
uint32_t *const   p_write_stat 
)

Function Name: SCUX_IoctlGetWriteStat.

Get write request status.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_write_stat:Writerequest status.
Return values:
None.

Definition at line 2378 of file scux_ioctl.c.

void SCUX_IoctlSetDvuCfg ( const int_t  channel,
const scux_dvu_cfg_t *const   p_dvu_param 
)

Function Name: SCUX_IoctlSetDvuCfg.

Set DVU parameter.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_dvu_param:DVUparameter.
Return values:
None.

Definition at line 1750 of file scux_ioctl.c.

int_t SCUX_IoctlSetDvuDigiVol ( const int_t  channel,
const scux_dvu_digi_vol_t *const   p_digi_vol_param 
)

Function Name: SCUX_IoctlSetDvuDigiVol.

Set Digital volume parameter.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_dvu_param:Digitalvolume parameter.
Return values:
ESUCCESS:Operationsuccessful. EPERM:Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 1810 of file scux_ioctl.c.

int_t SCUX_IoctlSetDvuRampVol ( const int_t  channel,
const scux_dvu_ramp_vol_t *const   p_ramp_vol_param 
)

Function Name: SCUX_IoctlSetDvuRampVol.

Set Digital volume parameter.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_dvu_param:Digitalvolume parameter.
Return values:
ESUCCESS:Operationsuccessful. EPERM:Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 1884 of file scux_ioctl.c.

int_t SCUX_IoctlSetDvuZerocrossMute ( const int_t  channel,
const scux_zc_mute_t *const   p_zc_mute_param 
)

Function Name: SCUX_IoctlSetDvuZerocrossMute.

Set zerocross mute parameter.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_zc_mute_param:zerocrossmute parameter.
Return values:
ESUCCESS:Operationsuccessful. EPERM:Parameter is unexpected value. EPERM:Rewrite callback pointer while waiting zerocross.

Definition at line 1991 of file scux_ioctl.c.

int_t SCUX_IoctlSetMixCfg ( const scux_mix_cfg_t *const   p_mix_param )

Function Name: SCUX_IoctlSetMixCfg.

Set MIX parameter.

Description:

Parameters:
[in]*p_mix_param:MIXparameter.
Return values:
ESUCCESS: Operation successful. EPERM : Transfer parameter is unexpected. EFAULT : Internal error is occured.

Definition at line 2110 of file scux_ioctl.c.

int_t SCUX_IoctlSetMixVol ( const int_t  channel,
const uint32_t  mix_vol 
)

Function Name: SCUX_IoctlSetMixVol.

Set MIX volume.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]mix_vol:MIXvolume.
Return values:
ESUCCESS: Operation successful. EPERM : Transfer parameter is unexpected. EFAULT: Internel error si occured.

Definition at line 2200 of file scux_ioctl.c.

int_t SCUX_IoctlSetPinClk ( const int_t  channel,
const scux_ssif_pin_clk_t *const   p_pin_clk_param 
)

Function Name: SCUX_IoctlSetPinClk.

Set clock source for AUDIO_CLK pin.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_pin_clk_param:clocksource parameter.
Return values:
ESUCCESS:Operationsuccessful. EPERM:Parameter is unexpected value. EFAULT:Internal error is occured.

Definition at line 1431 of file scux_ioctl.c.

int_t SCUX_IoctlSetPinMode ( const int_t  channel,
const scux_ssif_pin_mode_t *const   p_pin_mode_param 
)

Function Name: SCUX_IoctlSetPinMode.

Set synchronous setting for each SSIP pin.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_pin_mode_param:synchronoussetting parameter.
Return values:
ESUCCESS:Operationsuccessful. EPERM:Parameter is unexpected value. EFAUT:Internal error is occured.

Definition at line 1546 of file scux_ioctl.c.

void SCUX_IoctlSetRoute ( const int_t  channel,
const scux_route_t  route 
)

Function Name: SCUX_IoctlSetRoute.

Set SCUX data transfer route.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]route:routeparameter.
Return values:
None.

Definition at line 1397 of file scux_ioctl.c.

void SCUX_IoctlSetSrcCfg ( const int_t  channel,
const scux_src_cfg_t *const   p_src_param 
)

Function Name: SCUX_IoctlSetSrcCfg.

Set SRC paramter.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]*p_src_param:SRCparameter.
Return values:
None.

Definition at line 1698 of file scux_ioctl.c.

int_t SCUX_IoctlSetSsifCfg ( const scux_ssif_cfg_t *const   p_ssif_param )

Function Name: SCUX_IoctlSetSsifCfg.

Set SSIF parameter.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]p_ssif_param:SSIFparameter.
Return values:
ESUCCESS: Operation successful. EBADF : SSIF channel has already used on other SCUX channel. EPERM : Transfer parameter is unexpected. EFAULT: Internel error is occured.

Definition at line 2291 of file scux_ioctl.c.

int_t SCUX_IoctlSetStopMute ( const int_t  channel,
const uint32_t  audio_channel 
)

Function Name: SCUX_IoctlSetStopMute.

Stop mute.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]audio_channel:Audiochannel number.
Return values:
ESUCCESS:Operationsuccessful. EPERM:Parameter is unexpected value. EFAULT : Internal error is occured.

Definition at line 2053 of file scux_ioctl.c.

int_t SCUX_IoctlTransStart ( const int_t  channel )

Function Name: SCUX_IoctlTransStart.

SCUX transfer start.

Description:

Parameters:
[in]channel:SCUXchannel number.
[in]p_scux_addr_param:addressparameter.
Return values:
ESUCCESS: Operation successful. EACCES : DVU setup isn't carried out when using DVU. EACCES : MIX setup isn't carried out when using MIX. EACCES : SSIF setup isn't carried out when using SSIF. EACCES : SSIF channel is already used. EACCES : When use MIX, it is a setup which does not agree in a route setup. EBUSY : It has already transmitted. EMFILE : Allocate DMA ch for read is failed. EPERM : Transfer parameter is unexpected. EFAULT : Internal error is occured.

Definition at line 75 of file scux_ioctl.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.

void SCUX_SetDigiVolRegister ( const scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SetDigiVolRegister.

Set digital volume register.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
none.

Definition at line 3880 of file scux_dev.c.

void SCUX_SetMixVolRegister ( const int_t  channel )

Function Name: SCUX_SetMixVolRegister.

Set MIX volume register.

Description:

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

Definition at line 4083 of file scux_dev.c.

void SCUX_SetRampVolRegister ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SetRampVolRegister.

Set ramp volume register.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
none.

Definition at line 3962 of file scux_dev.c.

int_t SCUX_SetupDma ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SetupDma.

DMA setup.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 2794 of file scux_dev.c.

void SCUX_SetupDvu ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SetupDvu.

DVU module setup.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 2362 of file scux_dev.c.

void SCUX_SetupSrc ( scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SetupSrc.

SRC HW setup.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 1091 of file scux_dev.c.

void SCUX_SetupSsif ( const scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SetupSsif.

SSIF module setup.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 2533 of file scux_dev.c.

void SCUX_SetupSsifGpio ( const scux_ssif_ch_num_t  ssif_ch )

Function Name: SCUX_SetupSsifGpio.

GPIO of SSIF module setup.

Description:
R7S72100 Boards depended pin connections bellow
Clock settings
AUDIO_X1 : Private use pin(nothing to do)
AUDIO_X2 : No connection
AUDIO_CLK: Working with SSIF5
Channel settings
SSIF0 : Fully connected to WM8978
SSIF1 : Read only (NC:SSITxD1) connected to CD Deck
SSIF2 : No connection
SSIF3 : Write only (NC:SSIRxD3) connected to AK4353
SSIF4 : Fully connected to AK4353
SSIF5 : Fully connected to HCI

Parameters:
[in]ssif_ch:SSIF channel number.
Return values:
None.

Definition at line 257 of file scux_board.c.

void SCUX_SetZerocrossMuteRegister ( const scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SetZerocrossMuteRegister.

Set zerocross mute register.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 4027 of file scux_dev.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_SyncStartHw ( const scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SyncStartHw.

Start Hw on sync mode.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 3092 of file scux_dev.c.

void SCUX_SyncStopHw ( const scux_info_ch_t *const   p_scux_info_ch )

Function Name: SCUX_SyncStopHw.

Stop Hw on sync mode.

Description:

Parameters:
[in]*p_scux_info_ch: SCUX channel information.
Return values:
None.

Definition at line 3227 of file scux_dev.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.