Detailed Description

Linux module driver interface file.

============================================================================

Path:: /gpp/inc/sys/Linux/

Version:: 1.65.02.09 ============================================================================

Copyright:: Copyright (C) 2002-2012, Texas Instruments Incorporated - https://www.ti.com/

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ============================================================================

#include <linux/ioctl.h>
#include <dsplink.h>
#include <_dsplink.h>
#include <procdefs.h>
#include <linkcfgdefs.h>
#include <_idm_usr.h>

Include dependency graph for drvdefs.h:

Go to the source code of this file.

Data Structures

struct CMD_Args_tag

Defines

#define GROUP_BASE_CMD 0xe0

#define BASE_CMD 0x10

#define CMD_PROC_SETUP

#define CMD_PROC_DESTROY

#define CMD_PROC_START

#define CMD_PROC_STOP

#define CMD_PROC_LOAD

#define CMD_PROC_LOADSECTION

#define CMD_PROC_DETACH

#define CMD_PROC_ATTACH

#define CMD_PROC_GETSTATE

#define CMD_PROC_CONTROL

#define CMD_PROC_READ

#define CMD_PROC_WRITE

#define CMD_PROC_GETSYMBOLADDRESS

#define CMD_PROC_SENDTERMEVT

#define CMD_PROC_ISLASTDESTROY

#define CMD_PROC_ISLASTDETACH

#define CMD_PROC_CLEANUP

#define CMD_PROC_ADDRTRANSLATE

#define CMD_POOL_OPEN

#define CMD_POOL_CLOSE

#define CMD_POOL_ALLOC

#define CMD_POOL_FREE

#define CMD_POOL_TRANSLATEADDR

#define CMD_POOL_RECONFIGURE

#define CMD_POOL_WRITEBACK

#define CMD_POOL_INVALIDATE

#define CMD_NOTIFY_INITIALIZE

#define CMD_NOTIFY_FINALIZE

#define CMD_NOTIFY_REGISTER

#define CMD_NOTIFY_UNREGISTER

#define CMD_NOTIFY_NOTIFY

#define CMD_RINGIO_MAPREGION

#define CMD_RINGIO_UNMAPREGION

#define CMD_MPLIST_MAPREGION

#define CMD_MPLIST_UNMAPREGION

#define CMD_IDM_INIT

#define CMD_IDM_EXIT

#define CMD_IDM_CREATE

#define CMD_IDM_DELETE

#define CMD_IDM_ACQUIREID

#define CMD_IDM_RELEASEID

#define DRV_INITIALIZE(handle) DRV_Initialize (handle, NULL)

OS dependent definition of initialization function. ============================================================================.

#define DRV_FINALIZE(handle) DRV_Finalize (handle, NULL)

OS dependent definition of finalization function. ============================================================================.

#define DRV_INVOKE(handle, cmd, arg1) DRV_Invoke (handle, cmd, arg1, NULL)

OS dependent definition to call functions through ioctl's. ============================================================================.

Typedefs

CMD_Args

Union defining arguments to be passed to ioctl calls. For the explanation of individual field please see the corresponding APIs.

============================================================================

Parameters:

apiStatus Status returned by this API. apiArgs Union representing arguments for different APIs. ============================================================================

typedef struct CMD_Args_tag CMD_Args

Define Documentation

#define GROUP_BASE_CMD 0xe0

#define BASE_CMD 0x10

#define CMD_PROC_SETUP

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 1u,\
                                            CMD_Args)

#define CMD_PROC_DESTROY

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 2u,\
                                            CMD_Args)

#define CMD_PROC_START

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 3u,\
                                            CMD_Args)

#define CMD_PROC_STOP

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 4u,\
                                            CMD_Args)

#define CMD_PROC_LOAD

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 5u,\
                                            CMD_Args)

#define CMD_PROC_LOADSECTION

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 6u,\
                                            CMD_Args)

#define CMD_PROC_DETACH

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 7u,\
                                            CMD_Args)

#define CMD_PROC_ATTACH

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 8u,\
                                            CMD_Args)

#define CMD_PROC_GETSTATE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 9u,\
                                            CMD_Args)

#define CMD_PROC_CONTROL

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 10u,\
                                            CMD_Args)

#define CMD_PROC_READ

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 11u,\
                                            CMD_Args)

#define CMD_PROC_WRITE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 12u,\
                                            CMD_Args)

#define CMD_PROC_GETSYMBOLADDRESS

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 13u,\
                                            CMD_Args)

#define CMD_PROC_SENDTERMEVT

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 14u,\
                                            CMD_Args)

#define CMD_PROC_ISLASTDESTROY

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 15u,\
                                            CMD_Args)

#define CMD_PROC_ISLASTDETACH

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 16u,\
                                            CMD_Args)

#define CMD_PROC_CLEANUP

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 19u,\
                                            CMD_Args)

#define CMD_PROC_ADDRTRANSLATE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 20u,\
                                            CMD_Args)

#define CMD_POOL_OPEN

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 48u,\
                                            CMD_Args)

#define CMD_POOL_CLOSE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 49u,\
                                            CMD_Args)

#define CMD_POOL_ALLOC

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 50u,\
                                            CMD_Args)

#define CMD_POOL_FREE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 51u,\
                                            CMD_Args)

#define CMD_POOL_TRANSLATEADDR

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 52u,\
                                            CMD_Args)

#define CMD_POOL_RECONFIGURE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 53u,\
                                            CMD_Args)

#define CMD_POOL_WRITEBACK

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 54u,\
                                            CMD_Args)

#define CMD_POOL_INVALIDATE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 55u,\
                                            CMD_Args)

#define CMD_NOTIFY_INITIALIZE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 58u,\
                                            CMD_Args)

#define CMD_NOTIFY_FINALIZE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 59u,\
                                            CMD_Args)

#define CMD_NOTIFY_REGISTER

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 60u,\
                                            CMD_Args)

#define CMD_NOTIFY_UNREGISTER

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 61u,\
                                            CMD_Args)

#define CMD_NOTIFY_NOTIFY

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 62u,\
                                            CMD_Args)

#define CMD_RINGIO_MAPREGION

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 64u,\
                                            CMD_Args)

#define CMD_RINGIO_UNMAPREGION

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 65u,\
                                            CMD_Args)

#define CMD_MPLIST_MAPREGION

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 66u,\
                                            CMD_Args)

#define CMD_MPLIST_UNMAPREGION

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 67u,\
                                            CMD_Args)

#define CMD_IDM_INIT

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 68u,\
                                            CMD_Args)

#define CMD_IDM_EXIT

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 69u,\
                                            CMD_Args)

#define CMD_IDM_CREATE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 70u,\
                                            CMD_Args)

#define CMD_IDM_DELETE

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 71u,\
                                            CMD_Args)

#define CMD_IDM_ACQUIREID

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 72u,\
                                            CMD_Args)

#define CMD_IDM_RELEASEID

Value:

_IOWR(GROUP_BASE_CMD,\
                                            BASE_CMD + 73u,\
                                            CMD_Args)

#define DRV_INITIALIZE ( handle ) DRV_Initialize (handle, NULL)

OS dependent definition of initialization function. ============================================================================.

============================================================================

Macro:: DRV_INITIALIZE

#define DRV_FINALIZE ( handle ) DRV_Finalize (handle, NULL)

OS dependent definition of finalization function. ============================================================================.

============================================================================

Macro:: DRV_FINALIZE

#define DRV_INVOKE	(	handle,
		cmd,
		arg1
	)	DRV_Invoke (handle, cmd, arg1, NULL)

OS dependent definition to call functions through ioctl's. ============================================================================.

============================================================================

Macro:: DRV_INVOKE

Typedef Documentation

typedef struct CMD_Args_tag CMD_Args

drvdefs.h File Reference

Detailed Description

Data Structures

Defines

Typedefs

Define Documentation

Typedef Documentation