Routines to declare Driver Signature routines

Defines

#define OS_DEV_INIT_DCL(function_name)
#define OS_DEV_SHUTDOWN_DCL(function_name)
#define OS_DEV_OPEN_DCL(function_name)
#define OS_DEV_IOCTL_DCL(function_name)
#define OS_DEV_READ_DCL(function_name)
#define OS_DEV_WRITE_DCL(function_name)
#define OS_DEV_MMAP_DCL(function_name)
#define OS_DEV_CLOSE_DCL(function_name)
#define OS_DEV_ISR_DCL(function_name)
#define OS_DEV_TASK_DCL(function_name)

Detailed Description

These macros drop prototypes suitable for forward-declaration of function signatures.


Define Documentation

#define OS_DEV_CLOSE_DCL ( function_name   ) 

Declare prototype for the close function

Parameters:
function_name The name of the driver close() function
Returns:
A call to os_dev_close_return()
#define OS_DEV_INIT_DCL ( function_name   ) 

Declare prototype for the device initialization function

Parameters:
function_name The name of the portable initialization function.
#define OS_DEV_IOCTL_DCL ( function_name   ) 

Declare prototype for the user's ioctl() request function

Parameters:
function_name The name of the driver ioctl() function
Returns:
A call to os_dev_ioctl_return()
#define OS_DEV_ISR_DCL ( function_name   ) 

Declare prototype for the interrupt handling function

Parameters:
function_name The name of the driver ISR function
#define OS_DEV_MMAP_DCL ( function_name   ) 

Declare prototype for the user's mmap() request function

Parameters:
function_name The name of the driver mmap() function
#define OS_DEV_OPEN_DCL ( function_name   ) 

Declare prototype for the open() function.

Parameters:
function_name The name of the driver open() function
Returns:
A call to os_dev_open_return()
#define OS_DEV_READ_DCL ( function_name   ) 

Declare prototype for the function a user's read() request

Parameters:
function_name The name of the driver read() function
#define OS_DEV_SHUTDOWN_DCL ( function_name   ) 

Declare prototype for the device shutdown function

Parameters:
function_name The name of the portable driver shutdown routine.
Returns:
A call to os_dev_shutdown_return()
#define OS_DEV_TASK_DCL ( function_name   ) 

Declare prototype for a background task / bottom half function

Parameters:
function_name The name of this background task function
#define OS_DEV_WRITE_DCL ( function_name   ) 

Declare prototype for the user's write() request function

Parameters:
function_name The name of the driver write() function
footer
©  Freescale Semiconductor, Inc., 2007.  All rights reserved.
Freescale Confidential Proprietary
NDA Required
doxygen