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_if.c File Reference

scux_if.c File Reference

SCUX Driver interface functions. More...

Go to the source code of this file.

Functions

static void * R_SCUX_InitOne (const int_t channel, const void *const p_config_data, int32_t *const p_errno)
 Function Name: R_SCUX_InitOne.
static int_t R_SCUX_UnInitOne (const int_t channel, const void *const p_driver_instance, int32_t *const p_errno)
 Function Name: R_SCUX_UnInitOne.
static void * R_SCUX_Init (void *p_config_data, int32_t *const p_errno)
 Function Name: R_SCUX_Init.
static int_t R_SCUX_UnInit (void *p_driver_instance, int32_t *const p_errno)
 Function Name: R_SCUX_UnInit.
static int_t R_SCUX_Open (void *const p_driver_instance, const char_t *p_path_name, const int_t flags, int_t mode, int32_t *const p_errno)
 Function Name: R_SCUX_Open.
static int_t R_SCUX_Close (void *const p_fd, int32_t *const p_errno)
 Function Name: R_SCUX_Close.
static int_t R_SCUX_Ioctl (void *const p_fd, const int_t request, void *const p_buf, int32_t *const p_errno)
 Function Name: R_SCUX_Ioctl.
static int_t R_SCUX_WriteAsync (void *const p_fd, AIOCB *const p_aio, int32_t *const p_errno)
 Function Name: R_SCUX_WriteAsync.
static int_t R_SCUX_ReadAsync (void *const p_fd, AIOCB *const p_aio, int32_t *const p_errno)
 Function Name: R_SCUX_ReadAsync.
static int_t R_SCUX_Cancel (void *const p_fd, AIOCB *const p_aio, int32_t *const p_errno)
 Function Name: R_SCUX_Cancel.
static void SCUX_SetErrCode (int_t error_code, int32_t *const p_errno)
 Function Name: SCUX_SetErrCode.
RBSP_MBED_FNS * R_SCUX_MakeCbTbl_mbed (void)
 Function Name: R_SCUX_MakeCbTbl_mbed.
IOIF_DRV_API * R_SCUX_MakeCbTbl (void)
 Function Name: R_SCUX_MakeCbTbl.

Detailed Description

SCUX Driver interface functions.

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

Definition in file scux_if.c.


Function Documentation

static int_t R_SCUX_Cancel ( void *const   p_fd,
AIOCB *const   p_aio,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_Cancel.

Request cancel.

Description:

Parameters:
[in]p_fd:channel handle which was returned by R_SCUX_open
[in]p_aio:aio control block.
[in,out]p_errno:pointerof error code error code - EFAULT : Internal error is occured.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured.

Definition at line 1743 of file scux_if.c.

static int_t R_SCUX_Close ( void *const   p_fd,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_Close.

Close SCUX Channel.

Description:

Parameters:
[in]p_fd:whichwas returned by R_SCUX_Init()
[in,out]p_errno:pointerof error code error code - EFAULT : Internal error is occured.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured.

Definition at line 667 of file scux_if.c.

static void * R_SCUX_Init ( void *  p_config_data,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_Init.

Init SCUX driver.

Description:

Parameters:
[in]p_config_data:pointer of several parameters array per channels
[in,out]p_errno:pointer of error code error code - ENOMEM : Making semaphore failed. EBUSY : SCUX driver has been initialized already. EFAULT : p_config_data is NULL. EFAULT : Internal error is occured.
Return values:
otherthan (-1) Operation successful. EERROR - Error occured.

Definition at line 363 of file scux_if.c.

static void * R_SCUX_InitOne ( const int_t  channel,
const void *const   p_config_data,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_InitOne.

Init SCUX driver.

Description:

Parameters:
[in]channel:Initialize channel number.
[in]p_config_data:pointer of several parameters array per channels
[in,out]p_errno:pointer of error code error code - ENOMEM : Making semaphore failed. EBUSY : SCUX driver has been initialized already. EFAULT : p_config_data is NULL. EFAULT : Internal error is occured.
Return values:
otherthan (-1) Operation successful. EERROR - Error occured.

Definition at line 208 of file scux_if.c.

static int_t R_SCUX_Ioctl ( void *const   p_fd,
const int_t  request,
void *const   p_buf,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_Ioctl.

SCUX driver IOCTL function.

Description:

Parameters:
[in]p_fd,:pointer of SCUX handler
[in]request:IOCTLrequest code
[in]p_buf:Data buffer for IOCTL request code.
[in,out]p_errno:pointerof error code error code - EINVAL : IOCTL request code is unexpected value. EFAULT : Internal error is occured. other value : The value depending on IOCTL request code. Refer to the function of scux_ioctl.c for those meanings.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured.

Definition at line 768 of file scux_if.c.

IOIF_DRV_API* R_SCUX_MakeCbTbl ( void   )

Function Name: R_SCUX_MakeCbTbl.

Returns the SCUX driver callback function table.

Description:

Parameters:
none
Return values:
pointerof sample driver callback table

Definition at line 134 of file scux_if.c.

RBSP_MBED_FNS* R_SCUX_MakeCbTbl_mbed ( void   )

Function Name: R_SCUX_MakeCbTbl_mbed.

Returns the SCUX driver callback function table.

Description:

Parameters:
none
Return values:
pointerof sample driver callback table

Definition at line 103 of file scux_if.c.

static int_t R_SCUX_Open ( void *const   p_driver_instance,
const char_t *  p_path_name,
const int_t  flags,
int_t  mode,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_Open.

Open SCUX Channel.

Description:

Parameters:
[in]p_driver_instance:whichwas returned by R_SCUX_Init()
[in]p_path_name:device Name
[in]flags:specifies the access mode whether the channel is opened for a read or a write
[in]mode:specifies the permissions to use in case a new file is created (not used for serial family driver)
[in,out]p_errno:pointer of error code error code - ENOMEM : Craeaton of IOIF queue is failed. ENOENT : Pathname is incorrect length. ENOENT : Channel information is NULL. EACCES : Setting to flag is other than O_WONLY or O_RDWR EMFILE : Allocation of write DMA channel is failed. ENOTSUP : Channel is not support. EFAULT : Internal error is occured.
Return values:
ExceptERROR - Operation successful. EERROR - Error occured.

Definition at line 499 of file scux_if.c.

static int_t R_SCUX_ReadAsync ( void *const   p_fd,
AIOCB *const   p_aio,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_ReadAsync.

SCUX driver asynchronous read.

Description:

Parameters:
[in]p_fd:channel handle which was returned by R_SCUX_open
[in]p_aio:aio control block.
[in,out]p_errno:pointerof error code error code - EBADF : Channel status isn't SCUX_CH_STOP or SCUX_CH_STOP_WAIT. EINVAL : read size is 0. EACCES : Request for write only mode channel. EACCES : Route setting is unexpected. EFAULT : Internal error is occured.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured.

Definition at line 1575 of file scux_if.c.

static int_t R_SCUX_UnInit ( void *  p_driver_instance,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_UnInit.

Uninit SCUX driver.

Description:

Parameters:
[in]p_driver_instance:which was returned by R_SCUX_Init
[in,out]p_errno:pointer of error code error code - EBADF : Driver status isn't SCUX_DRV_INIT.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured.

Definition at line 431 of file scux_if.c.

static int_t R_SCUX_UnInitOne ( const int_t  channel,
const void *const   p_driver_instance,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_UnInitOne.

Uninit SCUX driver.

Description:

Parameters:
[in]channel:Uninitialize channel number.
[in]p_driver_instance:which was returned by R_SCUX_Init
[in,out]p_errno:pointer of error code error code - EBADF : Driver status isn't SCUX_DRV_INIT.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured.

Definition at line 285 of file scux_if.c.

static int_t R_SCUX_WriteAsync ( void *const   p_fd,
AIOCB *const   p_aio,
int32_t *const   p_errno 
) [static]

Function Name: R_SCUX_WriteAsync.

SCUX driver asynchronous write.

Description:

Parameters:
[in]p_fd:channel handle which was returned by R_SCUX_Open
[in]p_aio:aio control block.
[in,out]p_errno:pointerof error code error code - EBADF : Channel status isn't SCUX_CH_STOP or SCUX_CH_STOP_WAIT. EINVAL : p_fd is NULL. EINVAL : write size is 0. EFAULT : Internal error is occured.
Return values:
ESUCCESS- Operation successful. EERROR - Error occured.

Definition at line 1418 of file scux_if.c.

static void SCUX_SetErrCode ( int_t  error_code,
int32_t *const   p_errno 
) [static]

Function Name: SCUX_SetErrCode.

Set error code to error code pointer.

Description:
If error code pointer is NULL, nothing is done.

Parameters:
[in]error_code:Error code.
[in,out]p_errno:Pointer of set error code.
Return values:
none

Definition at line 170 of file scux_if.c.