Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals | Related Pages

drvdefs.h File Reference

Linux module driver interface file. More...

#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

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 CMD_Args_tag CMD_Args

Defines

#define DRV_PMGR_H
#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_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. ============================================================================.


Detailed Description

Linux module driver interface file.

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

Path:
/db/swcoe_asp/DSPLINK_Build/dsplink_linux_1_65_00_03/dsplink/gpp/inc/sys/Linux/
Version:
1.65.00.03 ============================================================================
Copyright:
Copyright (C) 2002-2009, Texas Instruments Incorporated - http://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. ============================================================================

Definition in file drvdefs.h.


Define Documentation

#define BASE_CMD   0x10
 

Definition at line 99 of file drvdefs.h.

#define CMD_IDM_ACQUIREID
 

Value:

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

Definition at line 490 of file drvdefs.h.

#define CMD_IDM_CREATE
 

Value:

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

Definition at line 482 of file drvdefs.h.

#define CMD_IDM_DELETE
 

Value:

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

Definition at line 486 of file drvdefs.h.

#define CMD_IDM_EXIT
 

Value:

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

Definition at line 478 of file drvdefs.h.

#define CMD_IDM_INIT
 

Value:

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

Definition at line 474 of file drvdefs.h.

#define CMD_IDM_RELEASEID
 

Value:

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

Definition at line 494 of file drvdefs.h.

#define CMD_MPLIST_MAPREGION
 

Value:

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

Definition at line 459 of file drvdefs.h.

#define CMD_MPLIST_UNMAPREGION
 

Value:

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

Definition at line 463 of file drvdefs.h.

#define CMD_NOTIFY_FINALIZE
 

Value:

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

Definition at line 414 of file drvdefs.h.

#define CMD_NOTIFY_INITIALIZE
 

Value:

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

Definition at line 410 of file drvdefs.h.

#define CMD_NOTIFY_NOTIFY
 

Value:

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

Definition at line 426 of file drvdefs.h.

#define CMD_NOTIFY_REGISTER
 

Value:

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

Definition at line 418 of file drvdefs.h.

#define CMD_NOTIFY_UNREGISTER
 

Value:

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

Definition at line 422 of file drvdefs.h.

#define CMD_POOL_ALLOC
 

Value:

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

Definition at line 362 of file drvdefs.h.

#define CMD_POOL_CLOSE
 

Value:

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

Definition at line 358 of file drvdefs.h.

#define CMD_POOL_FREE
 

Value:

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

Definition at line 366 of file drvdefs.h.

#define CMD_POOL_INVALIDATE
 

Value:

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

Definition at line 382 of file drvdefs.h.

#define CMD_POOL_OPEN
 

Value:

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

Definition at line 354 of file drvdefs.h.

#define CMD_POOL_RECONFIGURE
 

Value:

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

Definition at line 374 of file drvdefs.h.

#define CMD_POOL_TRANSLATEADDR
 

Value:

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

Definition at line 370 of file drvdefs.h.

#define CMD_POOL_WRITEBACK
 

Value:

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

Definition at line 378 of file drvdefs.h.

#define CMD_PROC_ADDRTRANSLATE
 

Value:

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

Definition at line 187 of file drvdefs.h.

#define CMD_PROC_ATTACH
 

Value:

Definition at line 136 of file drvdefs.h.

#define CMD_PROC_CLEANUP
 

Value:

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

Definition at line 183 of file drvdefs.h.

#define CMD_PROC_CONTROL
 

Value:

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

Definition at line 144 of file drvdefs.h.

#define CMD_PROC_DESTROY
 

Value:

Definition at line 111 of file drvdefs.h.

#define CMD_PROC_DETACH
 

Value:

Definition at line 132 of file drvdefs.h.

#define CMD_PROC_GETSTATE
 

Value:

Definition at line 140 of file drvdefs.h.

#define CMD_PROC_GETSYMBOLADDRESS
 

Value:

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

Definition at line 156 of file drvdefs.h.

#define CMD_PROC_ISLASTDESTROY
 

Value:

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

Definition at line 160 of file drvdefs.h.

#define CMD_PROC_ISLASTDETACH
 

Value:

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

Definition at line 164 of file drvdefs.h.

#define CMD_PROC_LOAD
 

Value:

Definition at line 124 of file drvdefs.h.

#define CMD_PROC_LOADSECTION
 

Value:

Definition at line 128 of file drvdefs.h.

#define CMD_PROC_READ
 

Value:

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

Definition at line 148 of file drvdefs.h.

#define CMD_PROC_SETUP
 

Value:

Definition at line 107 of file drvdefs.h.

#define CMD_PROC_START
 

Value:

Definition at line 116 of file drvdefs.h.

#define CMD_PROC_STOP
 

Value:

Definition at line 120 of file drvdefs.h.

#define CMD_PROC_WRITE
 

Value:

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

Definition at line 152 of file drvdefs.h.

#define CMD_RINGIO_MAPREGION
 

Value:

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

Definition at line 444 of file drvdefs.h.

#define CMD_RINGIO_UNMAPREGION
 

Value:

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

Definition at line 448 of file drvdefs.h.

#define DRV_FINALIZE handle   )     DRV_Finalize (handle, NULL)
 

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

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

Macro:
DRV_FINALIZE

Definition at line 513 of file drvdefs.h.

#define DRV_INITIALIZE handle   )     DRV_Initialize (handle, NULL)
 

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

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

Macro:
DRV_INITIALIZE

Definition at line 505 of file drvdefs.h.

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

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

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

Macro:
DRV_INVOKE

Definition at line 521 of file drvdefs.h.

#define DRV_PMGR_H
 

Definition at line 44 of file drvdefs.h.

#define GROUP_BASE_CMD   0xe0
 

Definition at line 91 of file drvdefs.h.


Typedef Documentation

typedef struct CMD_Args_tag CMD_Args
 


Generated on Fri Jul 16 14:34:06 2010 for DSP/BIOSLink by  doxygen 1.4.4