From 634f8c383f6ec9ba8ad86182b0b986b2acb928ba Mon Sep 17 00:00:00 2001 From: Hiroshi DOYU Date: Fri, 15 Aug 2008 01:55:54 +0300 Subject: [PATCH 02/15] TI DSP BRIDGE: Header files Initial port from omapzoom http://omapzoom.org/gf/project/omapbridge For details, http://omapzoom.org/gf/project/omapbridge/docman/?subdir=3 Signed-off-by: Hiroshi DOYU --- arch/arm/plat-omap/include/bridge/_chnl_sm.h | 221 ++++ arch/arm/plat-omap/include/bridge/_dcd.h | 187 +++ arch/arm/plat-omap/include/bridge/brddefs.h | 54 + arch/arm/plat-omap/include/bridge/cfg.h | 339 ++++++ arch/arm/plat-omap/include/bridge/cfgdefs.h | 127 +++ arch/arm/plat-omap/include/bridge/chnl.h | 537 +++++++++ arch/arm/plat-omap/include/bridge/chnl_sm.h | 210 ++++ arch/arm/plat-omap/include/bridge/chnldefs.h | 92 ++ arch/arm/plat-omap/include/bridge/chnlpriv.h | 136 +++ arch/arm/plat-omap/include/bridge/clk.h | 155 +++ arch/arm/plat-omap/include/bridge/cmm.h | 420 +++++++ arch/arm/plat-omap/include/bridge/cmmdefs.h | 135 +++ arch/arm/plat-omap/include/bridge/cod.h | 494 ++++++++ arch/arm/plat-omap/include/bridge/csl.h | 269 +++++ arch/arm/plat-omap/include/bridge/dbapi.h | 48 + arch/arm/plat-omap/include/bridge/dbc.h | 66 ++ arch/arm/plat-omap/include/bridge/dbdcd.h | 388 +++++++ arch/arm/plat-omap/include/bridge/dbdcddef.h | 94 ++ arch/arm/plat-omap/include/bridge/dbdefs.h | 564 +++++++++ arch/arm/plat-omap/include/bridge/dbg.h | 110 ++ arch/arm/plat-omap/include/bridge/dbl.h | 354 ++++++ arch/arm/plat-omap/include/bridge/dbldefs.h | 519 +++++++++ arch/arm/plat-omap/include/bridge/dbll.h | 70 ++ arch/arm/plat-omap/include/bridge/dblldefs.h | 513 +++++++++ arch/arm/plat-omap/include/bridge/dbof.h | 117 ++ arch/arm/plat-omap/include/bridge/dbreg.h | 113 ++ arch/arm/plat-omap/include/bridge/dbtype.h | 105 ++ arch/arm/plat-omap/include/bridge/ddma_sh.h | 95 ++ arch/arm/plat-omap/include/bridge/ddmatypes.h | 36 + arch/arm/plat-omap/include/bridge/dehdefs.h | 42 + arch/arm/plat-omap/include/bridge/dev.h | 804 +++++++++++++ arch/arm/plat-omap/include/bridge/devdefs.h | 35 + arch/arm/plat-omap/include/bridge/disp.h | 236 ++++ arch/arm/plat-omap/include/bridge/dispdefs.h | 45 + arch/arm/plat-omap/include/bridge/dldr.h | 75 ++ arch/arm/plat-omap/include/bridge/dldrdefs.h | 315 ++++++ arch/arm/plat-omap/include/bridge/dmm.h | 85 ++ arch/arm/plat-omap/include/bridge/dpc.h | 167 +++ arch/arm/plat-omap/include/bridge/drv.h | 434 +++++++ arch/arm/plat-omap/include/bridge/drvdefs.h | 34 + arch/arm/plat-omap/include/bridge/dspapi.h | 50 + arch/arm/plat-omap/include/bridge/dspdrv.h | 106 ++ arch/arm/plat-omap/include/bridge/dynamic_loader.h | 505 +++++++++ arch/arm/plat-omap/include/bridge/errbase.h | 509 +++++++++ arch/arm/plat-omap/include/bridge/gb.h | 85 ++ arch/arm/plat-omap/include/bridge/getsection.h | 121 ++ arch/arm/plat-omap/include/bridge/gh.h | 37 + arch/arm/plat-omap/include/bridge/gp.h | 33 + arch/arm/plat-omap/include/bridge/gs.h | 64 ++ arch/arm/plat-omap/include/bridge/gt.h | 317 ++++++ arch/arm/plat-omap/include/bridge/host_os.h | 80 ++ arch/arm/plat-omap/include/bridge/io.h | 132 +++ arch/arm/plat-omap/include/bridge/io_sm.h | 330 ++++++ arch/arm/plat-omap/include/bridge/iodefs.h | 45 + arch/arm/plat-omap/include/bridge/isr.h | 219 ++++ arch/arm/plat-omap/include/bridge/kfile.h | 216 ++++ arch/arm/plat-omap/include/bridge/ldr.h | 51 + arch/arm/plat-omap/include/bridge/list.h | 296 +++++ arch/arm/plat-omap/include/bridge/mbx_sh.h | 213 ++++ arch/arm/plat-omap/include/bridge/mem.h | 340 ++++++ arch/arm/plat-omap/include/bridge/memdefs.h | 52 + arch/arm/plat-omap/include/bridge/memry.h | 96 ++ arch/arm/plat-omap/include/bridge/mgr.h | 234 ++++ arch/arm/plat-omap/include/bridge/mgrpriv.h | 55 + arch/arm/plat-omap/include/bridge/msg.h | 106 ++ arch/arm/plat-omap/include/bridge/msgdefs.h | 43 + arch/arm/plat-omap/include/bridge/nldr.h | 81 ++ arch/arm/plat-omap/include/bridge/nldrdefs.h | 307 +++++ arch/arm/plat-omap/include/bridge/node.h | 619 ++++++++++ arch/arm/plat-omap/include/bridge/nodedefs.h | 40 + arch/arm/plat-omap/include/bridge/nodepriv.h | 237 ++++ arch/arm/plat-omap/include/bridge/ntfy.h | 146 +++ arch/arm/plat-omap/include/bridge/prcs.h | 101 ++ arch/arm/plat-omap/include/bridge/proc.h | 648 +++++++++++ arch/arm/plat-omap/include/bridge/procpriv.h | 35 + arch/arm/plat-omap/include/bridge/pwr.h | 129 +++ arch/arm/plat-omap/include/bridge/pwr_sh.h | 41 + arch/arm/plat-omap/include/bridge/reg.h | 257 +++++ .../arm/plat-omap/include/bridge/resourcecleanup.h | 89 ++ arch/arm/plat-omap/include/bridge/rmm.h | 199 ++++ arch/arm/plat-omap/include/bridge/rms_sh.h | 125 ++ arch/arm/plat-omap/include/bridge/rmstypes.h | 41 + arch/arm/plat-omap/include/bridge/services.h | 63 + arch/arm/plat-omap/include/bridge/std.h | 143 +++ arch/arm/plat-omap/include/bridge/strm.h | 441 ++++++++ arch/arm/plat-omap/include/bridge/strmdefs.h | 57 + arch/arm/plat-omap/include/bridge/sync.h | 339 ++++++ arch/arm/plat-omap/include/bridge/util.h | 173 +++ arch/arm/plat-omap/include/bridge/utildefs.h | 51 + arch/arm/plat-omap/include/bridge/uuidutil.h | 74 ++ arch/arm/plat-omap/include/bridge/wcd.h | 61 + arch/arm/plat-omap/include/bridge/wcdioctl.h | 518 +++++++++ arch/arm/plat-omap/include/bridge/wmd.h | 1193 ++++++++++++++++++++ arch/arm/plat-omap/include/bridge/wmdchnl.h | 90 ++ arch/arm/plat-omap/include/bridge/wmddeh.h | 64 ++ arch/arm/plat-omap/include/bridge/wmdio.h | 53 + arch/arm/plat-omap/include/bridge/wmdioctl.h | 91 ++ arch/arm/plat-omap/include/bridge/wmdmsg.h | 70 ++ 98 files changed, 19751 insertions(+), 0 deletions(-) create mode 100644 arch/arm/plat-omap/include/bridge/_chnl_sm.h create mode 100644 arch/arm/plat-omap/include/bridge/_dcd.h create mode 100644 arch/arm/plat-omap/include/bridge/brddefs.h create mode 100644 arch/arm/plat-omap/include/bridge/cfg.h create mode 100644 arch/arm/plat-omap/include/bridge/cfgdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/chnl.h create mode 100644 arch/arm/plat-omap/include/bridge/chnl_sm.h create mode 100644 arch/arm/plat-omap/include/bridge/chnldefs.h create mode 100644 arch/arm/plat-omap/include/bridge/chnlpriv.h create mode 100644 arch/arm/plat-omap/include/bridge/clk.h create mode 100644 arch/arm/plat-omap/include/bridge/cmm.h create mode 100644 arch/arm/plat-omap/include/bridge/cmmdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/cod.h create mode 100644 arch/arm/plat-omap/include/bridge/csl.h create mode 100644 arch/arm/plat-omap/include/bridge/dbapi.h create mode 100644 arch/arm/plat-omap/include/bridge/dbc.h create mode 100644 arch/arm/plat-omap/include/bridge/dbdcd.h create mode 100644 arch/arm/plat-omap/include/bridge/dbdcddef.h create mode 100644 arch/arm/plat-omap/include/bridge/dbdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/dbg.h create mode 100644 arch/arm/plat-omap/include/bridge/dbl.h create mode 100644 arch/arm/plat-omap/include/bridge/dbldefs.h create mode 100644 arch/arm/plat-omap/include/bridge/dbll.h create mode 100644 arch/arm/plat-omap/include/bridge/dblldefs.h create mode 100644 arch/arm/plat-omap/include/bridge/dbof.h create mode 100644 arch/arm/plat-omap/include/bridge/dbreg.h create mode 100644 arch/arm/plat-omap/include/bridge/dbtype.h create mode 100644 arch/arm/plat-omap/include/bridge/ddma_sh.h create mode 100644 arch/arm/plat-omap/include/bridge/ddmatypes.h create mode 100644 arch/arm/plat-omap/include/bridge/dehdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/dev.h create mode 100644 arch/arm/plat-omap/include/bridge/devdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/disp.h create mode 100644 arch/arm/plat-omap/include/bridge/dispdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/dldr.h create mode 100644 arch/arm/plat-omap/include/bridge/dldrdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/dmm.h create mode 100644 arch/arm/plat-omap/include/bridge/dpc.h create mode 100644 arch/arm/plat-omap/include/bridge/drv.h create mode 100644 arch/arm/plat-omap/include/bridge/drvdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/dspapi.h create mode 100644 arch/arm/plat-omap/include/bridge/dspdrv.h create mode 100644 arch/arm/plat-omap/include/bridge/dynamic_loader.h create mode 100644 arch/arm/plat-omap/include/bridge/errbase.h create mode 100644 arch/arm/plat-omap/include/bridge/gb.h create mode 100644 arch/arm/plat-omap/include/bridge/getsection.h create mode 100644 arch/arm/plat-omap/include/bridge/gh.h create mode 100644 arch/arm/plat-omap/include/bridge/gp.h create mode 100644 arch/arm/plat-omap/include/bridge/gs.h create mode 100644 arch/arm/plat-omap/include/bridge/gt.h create mode 100644 arch/arm/plat-omap/include/bridge/host_os.h create mode 100644 arch/arm/plat-omap/include/bridge/io.h create mode 100644 arch/arm/plat-omap/include/bridge/io_sm.h create mode 100644 arch/arm/plat-omap/include/bridge/iodefs.h create mode 100644 arch/arm/plat-omap/include/bridge/isr.h create mode 100644 arch/arm/plat-omap/include/bridge/kfile.h create mode 100644 arch/arm/plat-omap/include/bridge/ldr.h create mode 100644 arch/arm/plat-omap/include/bridge/list.h create mode 100644 arch/arm/plat-omap/include/bridge/mbx_sh.h create mode 100644 arch/arm/plat-omap/include/bridge/mem.h create mode 100644 arch/arm/plat-omap/include/bridge/memdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/memry.h create mode 100644 arch/arm/plat-omap/include/bridge/mgr.h create mode 100644 arch/arm/plat-omap/include/bridge/mgrpriv.h create mode 100644 arch/arm/plat-omap/include/bridge/msg.h create mode 100644 arch/arm/plat-omap/include/bridge/msgdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/nldr.h create mode 100644 arch/arm/plat-omap/include/bridge/nldrdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/node.h create mode 100644 arch/arm/plat-omap/include/bridge/nodedefs.h create mode 100644 arch/arm/plat-omap/include/bridge/nodepriv.h create mode 100644 arch/arm/plat-omap/include/bridge/ntfy.h create mode 100644 arch/arm/plat-omap/include/bridge/prcs.h create mode 100644 arch/arm/plat-omap/include/bridge/proc.h create mode 100644 arch/arm/plat-omap/include/bridge/procpriv.h create mode 100644 arch/arm/plat-omap/include/bridge/pwr.h create mode 100644 arch/arm/plat-omap/include/bridge/pwr_sh.h create mode 100644 arch/arm/plat-omap/include/bridge/reg.h create mode 100644 arch/arm/plat-omap/include/bridge/resourcecleanup.h create mode 100644 arch/arm/plat-omap/include/bridge/rmm.h create mode 100644 arch/arm/plat-omap/include/bridge/rms_sh.h create mode 100644 arch/arm/plat-omap/include/bridge/rmstypes.h create mode 100644 arch/arm/plat-omap/include/bridge/services.h create mode 100644 arch/arm/plat-omap/include/bridge/std.h create mode 100644 arch/arm/plat-omap/include/bridge/strm.h create mode 100644 arch/arm/plat-omap/include/bridge/strmdefs.h create mode 100644 arch/arm/plat-omap/include/bridge/sync.h create mode 100644 arch/arm/plat-omap/include/bridge/util.h create mode 100644 arch/arm/plat-omap/include/bridge/utildefs.h create mode 100644 arch/arm/plat-omap/include/bridge/uuidutil.h create mode 100644 arch/arm/plat-omap/include/bridge/wcd.h create mode 100644 arch/arm/plat-omap/include/bridge/wcdioctl.h create mode 100644 arch/arm/plat-omap/include/bridge/wmd.h create mode 100644 arch/arm/plat-omap/include/bridge/wmdchnl.h create mode 100644 arch/arm/plat-omap/include/bridge/wmddeh.h create mode 100644 arch/arm/plat-omap/include/bridge/wmdio.h create mode 100644 arch/arm/plat-omap/include/bridge/wmdioctl.h create mode 100644 arch/arm/plat-omap/include/bridge/wmdmsg.h diff --git a/arch/arm/plat-omap/include/bridge/_chnl_sm.h b/arch/arm/plat-omap/include/bridge/_chnl_sm.h new file mode 100644 index 0000000..c32ece4 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/_chnl_sm.h @@ -0,0 +1,221 @@ +/* + * arch/arm/plat-omap/include/bridge/_chnl_sm.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== _chnl_sm.h ======== + * Description: + * Private header file defining channel manager and channel objects for + * a shared memory channel driver. + * + * Public Functions: + * None. + * + * Notes: + * Shared between the modules implementing the shared memory channel class + * library. + * + *! Revision History: + *! ================ + *! 15-Oct-2002 kc Removed legacy PERF code. + *! 12-Jan-2002 ag Removed unused gppReqIO & ddmaChnlId DDMA fields. + *! Added zero-copy chnl descriptor array: zchnldesc. + *! 21-Dec-2001 ag Moved descPaGpp to private chnl obj from chnl descriptor. + *! 20-May-2001 ag/jeh Removed fShmSyms field from CHNL_MGR. + *! 04-Feb-2001 ag DSP-DMA support added. + *! 26-Oct-2000 jeh Added arg and resvd to SHM control structure. Added dwArg + *! to CHNL_IRP. + *! 16-Oct-2000 jeh Removed #ifdef DEBUG from around channel object's cIOCs + *! field, added cIOReqs. + *! 20-Jan-2000 ag: Incorporated code review comments. + *! 05-Jan-2000 ag: Text format cleanup. + *! 03-Nov-1999 ag: Added szEventName[] to CHNL object for name event support. + *! 02-Nov-1999 ag: _SHM_BEG & _END Syms from COFF now used for IO and SM CLASS. + *! 27-Oct-1999 jeh Define SHM structure to work for 16-bit targets. + *! 25-May-1999 jg: Added target side symbol names for share memory buffer + *! 03-Jan-1997 gp: Added fSharedIRQ field. + *! 22-Oct-1996 gp: Made dwProcessID a handle. + *! 09-Sep-1996 gp: Added dwProcessID field to CHNL_OBJECT. + *! 13-Aug-1996 gp: Created. + */ + +#ifndef _CHNL_SM_ +#define _CHNL_SM_ + +#include +#include +#include +#include + +#include +#include + +/* + * These target side symbols define the beginning and ending addresses + * of shared memory buffer. They are defined in the *cfg.cmd file by + * cdb code. + */ +#define CHNL_SHARED_BUFFER_BASE_SYM "_SHM_BEG" +#define CHNL_SHARED_BUFFER_LIMIT_SYM "_SHM_END" +#define BRIDGEINIT_BIOSGPTIMER "_BRIDGEINIT_BIOSGPTIMER" +#define BRIDGEINIT_LOADMON_GPTIMER "_BRIDGEINIT_LOADMON_GPTIMER" + +#ifndef _CHNL_WORDSIZE +#define _CHNL_WORDSIZE 4 /* default _CHNL_WORDSIZE is 2 bytes/word */ +#endif + +#ifdef CONFIG_ARCH_OMAP3430 + +#define MAXOPPS 16 + +struct oppTableEntry { + u32 voltage; + u32 frequency; + u32 minFreq; + u32 maxFreq; +} ; + +struct oppStruct { + u32 currOppPt; + u32 numOppPts; + struct oppTableEntry oppPoint[MAXOPPS]; +} ; + +/* Request to MPU */ +struct oppRqstStruct { + u32 rqstDspFreq; + u32 rqstOppPt; +}; + +/* Info to MPU */ +struct loadMonStruct { + u32 currDspLoad; + u32 currDspFreq; + u32 predDspLoad; + u32 predDspFreq; +}; + +#endif + + typedef u32 SMWORD; + + enum SHM_DESCTYPE { + SHM_CURROPP = 0, + SHM_OPPINFO = 1, + SHM_GETOPP = 2, /* Get DSP requested OPP info */ + } ; + +/* Structure in shared between DSP and PC for communication.*/ + struct SHM { + u32 dspFreeMask; /* Written by DSP, read by PC. */ + u32 hostFreeMask; /* Written by PC, read by DSP */ + + u32 inputFull; /* Input channel has unread data. */ + u32 inputId; /* Channel for which input is available. */ + u32 inputSize; /* Size of data block (in DSP words). */ + + u32 outputFull; /* Output channel has unread data. */ + u32 outputId; /* Channel for which output is available. */ + u32 outputSize; /* Size of data block (in DSP words). */ + + u32 arg; /* Arg for Issue/Reclaim (23 bits for 55x). */ + u32 resvd; /* Keep structure size even for 32-bit DSPs */ + +#ifdef CONFIG_ARCH_OMAP3430 + /* Operating Point structure */ + struct oppStruct oppTableStruct; + /* Operating Point Request structure */ + struct oppRqstStruct oppRequest; + /* load monitor information structure*/ + struct loadMonStruct loadMonInfo; + char dummy[184]; /* padding to 256 byte boundary */ + u32 shm_dbg_var[64]; /* shared memory debug variables */ +#endif + } ; + + /* Channel Manager: only one created per board: */ + struct CHNL_MGR { + u32 dwSignature; /* Used for object validation */ + /* Function interface to WMD */ + struct WMD_DRV_INTERFACE *pIntfFxns; + struct IO_MGR *hIOMgr; /* IO manager */ + /* Device this board represents */ + struct DEV_OBJECT *hDevObject; + + /* These fields initialized in WMD_CHNL_Create(): */ + u32 dwOutputMask; /* Host output channels w/ full buffers */ + u32 dwLastOutput; /* Last output channel fired from DPC */ + /* Critical section object handle */ + struct SYNC_CSOBJECT *hCSObj; + u32 uWordSize; /* Size in bytes of DSP word */ + u32 cChannels; /* Total number of channels */ + u32 cOpenChannels; /* Total number of open channels */ + struct CHNL_OBJECT **apChannel; /* Array of channels */ + u32 dwType; /* Type of channel class library */ + /* If no SHM syms, return for CHNL_Open */ + DSP_STATUS chnlOpenStatus; + } ; + +/* + * Channel: up to CHNL_MAXCHANNELS per board or if DSP-DMA supported then + * up to CHNL_MAXCHANNELS + CHNL_MAXDDMACHNLS per board. + */ + struct CHNL_OBJECT { + u32 dwSignature; /* Used for object validation */ + /* Pointer back to channel manager */ + struct CHNL_MGR *pChnlMgr; + u32 uId; /* Channel id */ + u32 dwState; /* Current channel state */ + u32 uMode; /* Chnl mode and attributes */ + /* Chnl I/O completion event (user mode) */ + HANDLE hUserEvent; + /* Abstract syncronization object */ + struct SYNC_OBJECT *hSyncEvent; + /* Name of Sync event */ + char szEventName[SYNC_MAXNAMELENGTH + 1]; + HANDLE hProcess; /* Process which created this channel */ + u32 pCBArg; /* Argument to use with callback */ + struct LST_LIST *pIORequests; /* List of IOR's to driver */ + s32 cIOCs; /* Number of IOC's in queue */ + s32 cIOReqs; /* Number of IORequests in queue */ + s32 cChirps; /* Initial number of free Irps */ + /* List of IOC's from driver */ + struct LST_LIST *pIOCompletions; + struct LST_LIST *pFreeList; /* List of free Irps */ + struct NTFY_OBJECT *hNtfy; + u32 cBytesMoved; /* Total number of bytes transfered */ + + /* For DSP-DMA */ + + /* Type of chnl transport:CHNL_[PCPY][DDMA] */ + u32 uChnlType; + } ; + +/* I/O Request/completion packet: */ + struct CHNL_IRP { + struct LST_ELEM link; /* Link to next CHIRP in queue. */ + /* Buffer to be filled/emptied. (User) */ + u8 *pHostUserBuf; + /* Buffer to be filled/emptied. (System) */ + u8 *pHostSysBuf; + u32 dwArg; /* Issue/Reclaim argument. */ + u32 uDspAddr; /* Transfer address on DSP side. */ + u32 cBytes; /* Bytes transferred. */ + u32 cBufSize; /* Actual buffer size when allocated. */ + u32 status; /* Status of IO completion. */ + } ; + +#endif /* _CHNL_SM_ */ diff --git a/arch/arm/plat-omap/include/bridge/_dcd.h b/arch/arm/plat-omap/include/bridge/_dcd.h new file mode 100644 index 0000000..56e0b51 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/_dcd.h @@ -0,0 +1,187 @@ +/* + * arch/arm/plat-omap/include/bridge/_dcd.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== _dcd.h ======== + * Description: + * Includes the wrapper functions called directly by the + * DeviceIOControl interface. + * + * Public Functions: + * WCD_CallDevIOCtl + * WCD_Init + * WCD_InitComplete2 + * WCD_Exit + * WRAP_* + * + * Notes: + * Compiled with CDECL calling convention. + * + *! Revision History: + *! ================ + *! 19-Apr-2004 sb Aligned DMM definitions with Symbian + *! 08-Mar-2004 sb Added the Dynamic Memory Mapping feature + *! 30-Jan-2002 ag Renamed CMMWRAP_AllocBuf to CMMWRAP_CallocBuf. + *! 22-Nov-2000 kc: Added MGRWRAP_GetPerf_Data to acquire PERF stats. + *! 27-Oct-2000 jeh Added NODEWRAP_AllocMsgBuf, NODEWRAP_FreeMsgBuf. Removed + *! NODEWRAP_GetMessageStream. + *! 10-Oct-2000 ag: Added user CMM wrappers. + *! 04-Aug-2000 rr: MEMWRAP and UTIL_Wrap added. + *! 27-Jul-2000 rr: NODEWRAP, STRMWRAP added. + *! 27-Jun-2000 rr: MGRWRAP fxns added.IFDEF to build for PM or DSP/BIOS Bridge + *! 03-Dec-1999 rr: WCD_InitComplete2 enabled for BRD_AutoStart. + *! 09-Nov-1999 kc: Added MEMRY. + *! 02-Nov-1999 ag: Added CHNL. + *! 08-Oct-1999 rr: Utilwrap_Testdll fxn added + *! 24-Sep-1999 rr: header changed from _wcd.h to _dcd.h + *! 09-Sep-1997 gp: Created. + */ + +#ifndef _WCD_ +#define _WCD_ + +#include + +/* + * ======== WCD_CallDevIOCtl ======== + * Purpose: + * Call the (wrapper) function for the corresponding WCD IOCTL. + * Parameters: + * cmd: IOCTL id, base 0. + * args: Argument structure. + * pResult: + * Returns: + * DSP_SOK if command called; DSP_EINVALIDARG if command not in IOCTL + * table. + * Requires: + * Ensures: + */ + extern DSP_STATUS WCD_CallDevIOCtl(unsigned int cmd, + union Trapped_Args *args, + u32 *pResult); + +/* + * ======== WCD_Init ======== + * Purpose: + * Initialize WCD modules, and export WCD services to WMD's. + * This procedure is called when the class driver is loaded. + * Parameters: + * Returns: + * TRUE if success; FALSE otherwise. + * Requires: + * Ensures: + */ + extern bool WCD_Init(); + +/* + * ======== WCD_InitComplete2 ======== + * Purpose: + * Perform any required WCD, and WMD initialization which + * cannot not be performed in WCD_Init() or DEV_StartDevice() due + * to the fact that some services are not yet + * completely initialized. + * Parameters: + * Returns: + * DSP_SOK: Allow this device to load + * DSP_EFAIL: Failure. + * Requires: + * WCD initialized. + * Ensures: + */ + extern DSP_STATUS WCD_InitComplete2(); + +/* + * ======== WCD_Exit ======== + * Purpose: + * Exit all modules initialized in WCD_Init(). + * This procedure is called when the class driver is unloaded. + * Parameters: + * Returns: + * Requires: + * WCD_Init() was previously called. + * Ensures: + * Resources acquired in WCD_Init() are freed. + */ + extern void WCD_Exit(); + +/* MGR wrapper functions */ + extern u32 MGRWRAP_EnumNode_Info(union Trapped_Args *args); + extern u32 MGRWRAP_EnumProc_Info(union Trapped_Args *args); + extern u32 MGRWRAP_RegisterObject(union Trapped_Args *args); + extern u32 MGRWRAP_UnregisterObject(union Trapped_Args *args); + extern u32 MGRWRAP_WaitForBridgeEvents(union Trapped_Args *args); + +#ifndef RES_CLEANUP_DISABLE + extern u32 MGRWRAP_GetProcessResourcesInfo(union Trapped_Args *args); +#endif + + +/* CPRC (Processor) wrapper Functions */ + extern u32 PROCWRAP_Attach(union Trapped_Args *args); + extern u32 PROCWRAP_Ctrl(union Trapped_Args *args); + extern u32 PROCWRAP_Detach(union Trapped_Args *args); + extern u32 PROCWRAP_EnumNode_Info(union Trapped_Args *args); + extern u32 PROCWRAP_EnumResources(union Trapped_Args *args); + extern u32 PROCWRAP_GetState(union Trapped_Args *args); + extern u32 PROCWRAP_GetTrace(union Trapped_Args *args); + extern u32 PROCWRAP_Load(union Trapped_Args *args); + extern u32 PROCWRAP_RegisterNotify(union Trapped_Args *args); + extern u32 PROCWRAP_Start(union Trapped_Args *args); + extern u32 PROCWRAP_ReserveMemory(union Trapped_Args *args); + extern u32 PROCWRAP_UnReserveMemory(union Trapped_Args *args); + extern u32 PROCWRAP_Map(union Trapped_Args *args); + extern u32 PROCWRAP_UnMap(union Trapped_Args *args); + extern u32 PROCWRAP_FlushMemory(union Trapped_Args *args); + extern u32 PROCWRAP_Stop(union Trapped_Args *args); + extern u32 PROCWRAP_InvalidateMemory(union Trapped_Args *args); + +/* NODE wrapper functions */ + extern u32 NODEWRAP_Allocate(union Trapped_Args *args); + extern u32 NODEWRAP_AllocMsgBuf(union Trapped_Args *args); + extern u32 NODEWRAP_ChangePriority(union Trapped_Args *args); + extern u32 NODEWRAP_Connect(union Trapped_Args *args); + extern u32 NODEWRAP_Create(union Trapped_Args *args); + extern u32 NODEWRAP_Delete(union Trapped_Args *args); + extern u32 NODEWRAP_FreeMsgBuf(union Trapped_Args *args); + extern u32 NODEWRAP_GetAttr(union Trapped_Args *args); + extern u32 NODEWRAP_GetMessage(union Trapped_Args *args); + extern u32 NODEWRAP_Pause(union Trapped_Args *args); + extern u32 NODEWRAP_PutMessage(union Trapped_Args *args); + extern u32 NODEWRAP_RegisterNotify(union Trapped_Args *args); + extern u32 NODEWRAP_Run(union Trapped_Args *args); + extern u32 NODEWRAP_Terminate(union Trapped_Args *args); + extern u32 NODEWRAP_GetUUIDProps(union Trapped_Args *args); + +/* STRM wrapper functions */ + extern u32 STRMWRAP_AllocateBuffer(union Trapped_Args *args); + extern u32 STRMWRAP_Close(union Trapped_Args *args); + extern u32 STRMWRAP_FreeBuffer(union Trapped_Args *args); + extern u32 STRMWRAP_GetEventHandle(union Trapped_Args *args); + extern u32 STRMWRAP_GetInfo(union Trapped_Args *args); + extern u32 STRMWRAP_Idle(union Trapped_Args *args); + extern u32 STRMWRAP_Issue(union Trapped_Args *args); + extern u32 STRMWRAP_Open(union Trapped_Args *args); + extern u32 STRMWRAP_Reclaim(union Trapped_Args *args); + extern u32 STRMWRAP_RegisterNotify(union Trapped_Args *args); + extern u32 STRMWRAP_Select(union Trapped_Args *args); + + extern u32 CMMWRAP_CallocBuf(union Trapped_Args *args); + extern u32 CMMWRAP_FreeBuf(union Trapped_Args *args); + extern u32 CMMWRAP_GetHandle(union Trapped_Args *args); + extern u32 CMMWRAP_GetInfo(union Trapped_Args *args); + +#endif /* _WCD_ */ diff --git a/arch/arm/plat-omap/include/bridge/brddefs.h b/arch/arm/plat-omap/include/bridge/brddefs.h new file mode 100644 index 0000000..553502d --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/brddefs.h @@ -0,0 +1,54 @@ +/* + * arch/arm/plat-omap/include/bridge/brddefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== brddefs.h ======== + * Description: + * Global BRD constants and types, shared between WSX, WCD, and WMD. + * + *! Revision History: + *! ================ + *! 31-Jan-2000 rr: Comment Exec changed to Monitor + *! 22-Jul-1999 jeh Added BRD_LOADED state. + *! 26-Mar-1997 gp: Added BRD_SYNCINIT state. + *! 11-Dec-1996 cr: Added BRD_LASTSTATE definition. + *! 11-Jul-1996 gp: Added missing u32 callback argument to BRD_CALLBACK. + *! 10-Jun-1996 gp: Created from board.h and brd.h. + */ + +#ifndef BRDDEFS_ +#define BRDDEFS_ + +/* platform status values */ +#define BRD_STOPPED 0x0 /* No Monitor Loaded, Not running. */ +#define BRD_IDLE 0x1 /* Monitor Loaded, but suspended. */ +#define BRD_RUNNING 0x2 /* Monitor loaded, and executing. */ +#define BRD_UNKNOWN 0x3 /* Board state is indeterminate. */ +#define BRD_SYNCINIT 0x4 +#define BRD_LOADED 0x5 +#define BRD_LASTSTATE BRD_LOADED /* Set to highest legal board state. */ +#define BRD_SLEEP_TRANSITION 0x6 /* Sleep transition in progress */ +#define BRD_HIBERNATION 0x7 /* MPU initiated hibernation */ +#define BRD_RETENTION 0x8 /* Retention mode */ +#define BRD_DSP_HIBERNATION 0x9 /* DSP initiated hibernation */ + + typedef u32 BRD_STATUS; + +/* BRD Object */ + struct BRD_OBJECT; + +#endif /* BRDDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/cfg.h b/arch/arm/plat-omap/include/bridge/cfg.h new file mode 100644 index 0000000..1473d79 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/cfg.h @@ -0,0 +1,339 @@ +/* + * arch/arm/plat-omap/include/bridge/cfg.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== cfg.h ======== + * Purpose: + * PM Configuration module. + * + * Private Functions: + * CFG_Exit + * CFG_GetAutoStart + * CFG_GetCDVersion + * CFG_GetDevObject + * CFG_GetDSPResources + * CFG_GetExecFile + * CFG_GetHostResources + * CFG_GetObject + * CFG_GetPerfValue + * CFG_GetWMDFileName + * CFG_GetZLFile + * CFG_Init + * CFG_SetDevObject + * CFG_SetObject + * + *! Revision History: + *! ================= + *! 26-Feb-2003 kc Removed unused CFG fxns. + *! 28-Aug-2001 jeh Added CFG_GetLoaderName. + *! 26-Jul-2000 rr: Added CFG_GetDCDName to retrieve the DCD Dll name. + *! 13-Jul-2000 rr: Added CFG_GetObject & CFG_SetObject. + *! 13-Jan-2000 rr: CFG_Get/SetPrivateDword renamed to CFG_Get/SetDevObject. + *! CFG_GetWinBRIDGEDir/Directory,CFG_GetSearchPath removed. + *! 15-Jan-1998 cr: Code review cleanup. + *! 16-Aug-1997 cr: Added explicit cdecl identifiers. + *! 12-Dec-1996 gp: Moved CFG_FindInSearchPath to CSP module. + *! 13-Sep-1996 gp: Added CFG_GetBoardName(). + *! 22-Jul-1996 gp: Added CFG_GetTraceStr, to retrieve an initial GT trace. + *! 26-Jun-1996 cr: Added CFG_FindInSearchPath. + *! 25-Jun-1996 cr: Added CFG_GetWinSPOXDir. + *! 17-Jun-1996 cr: Added CFG_GetDevNode. + *! 11-Jun-1996 cr: Cleaned up for code review. + *! 07-Jun-1996 cr: Added CFG_GetExecFile and CFG_GetZLFileName functions. + *! 04-Jun-1996 gp: Added AutoStart regkey and accessor function. Placed + *! OUT parameters in accessor function param. lists at end. + *! 29-May-1996 gp: Moved DEV_HDEVNODE to here and renamed CFG_HDEVNODE. + *! 22-May-1996 cr: Added GetHostResources, GetDSPResources, and + *! GetWMDFileName services. + *! 18-May-1996 gp: Created. + */ + +#ifndef CFG_ +#define CFG_ +#include +#include + +/* + * ======== CFG_Exit ======== + * Purpose: + * Discontinue usage of the CFG module. + * Parameters: + * Returns: + * Requires: + * CFG_Init() was previously called. + * Ensures: + * Resources acquired in CFG_Init() are freed. + */ + extern void CFG_Exit(); + +/* + * ======== CFG_GetAutoStart ======== + * Purpose: + * Retreive the autostart mask, if any, for this board. + * Parameters: + * hDevNode: Handle to the DevNode who's WMD we are querying. + * pdwAutoStart: Ptr to location for 32 bit autostart mask. + * Returns: + * DSP_SOK: Success. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * CFG_E_RESOURCENOTAVAIL: Unable to retreive resource. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: *pdwAutoStart contains autostart mask for this devnode. + */ + extern DSP_STATUS CFG_GetAutoStart(IN struct CFG_DEVNODE *hDevNode, + OUT u32 *pdwAutoStart); + +/* + * ======== CFG_GetCDVersion ======== + * Purpose: + * Retrieves the version of the PM Class Driver. + * Parameters: + * pdwVersion: Ptr to u32 to contain version number upon return. + * Returns: + * DSP_SOK: Success. pdwVersion contains Class Driver version in + * the form: 0xAABBCCDD where AABB is Major version and + * CCDD is Minor. + * DSP_EFAIL: Failure. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: Success. + * else: *pdwVersion is NULL. + */ + extern DSP_STATUS CFG_GetCDVersion(OUT u32 *pdwVersion); + +/* + * ======== CFG_GetDevObject ======== + * Purpose: + * Retrieve the Device Object handle for a given devnode. + * Parameters: + * hDevNode: Platform's DevNode handle from which to retrieve value. + * pdwValue: Ptr to location to store the value. + * Returns: + * DSP_SOK: Success. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * CFG_E_INVALIDPOINTER: phDevObject is invalid. + * CFG_E_RESOURCENOTAVAIL: The resource is not available. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: *pdwValue is set to the retrieved u32. + * else: *pdwValue is set to 0L. + */ + extern DSP_STATUS CFG_GetDevObject(IN struct CFG_DEVNODE *hDevNode, + OUT u32 *pdwValue); + +/* + * ======== CFG_GetDSPResources ======== + * Purpose: + * Get the DSP resources available to a given device. + * Parameters: + * hDevNode: Handle to the DEVNODE who's resources we are querying. + * pDSPResTable: Ptr to a location to store the DSP resource table. + * Returns: + * DSP_SOK: On success. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * CFG_E_RESOURCENOTAVAIL: The DSP Resource information is not + * available + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: pDSPResTable points to a filled table of resources allocated + * for the specified WMD. + */ + extern DSP_STATUS CFG_GetDSPResources(IN struct CFG_DEVNODE *hDevNode, + OUT struct CFG_DSPRES *pDSPResTable); + + +/* + * ======== CFG_GetExecFile ======== + * Purpose: + * Retreive the default executable, if any, for this board. + * Parameters: + * hDevNode: Handle to the DevNode who's WMD we are querying. + * cBufSize: Size of buffer. + * pstrExecFile: Ptr to character buf to hold ExecFile. + * Returns: + * DSP_SOK: Success. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * CFG_E_INVALIDPOINTER: pstrExecFile is invalid. + * CFG_E_RESOURCENOTAVAIL: The resource is not available. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: Not more than cBufSize bytes were copied into pstrExecFile, + * and *pstrExecFile contains default executable for this + * devnode. + */ + extern DSP_STATUS CFG_GetExecFile(IN struct CFG_DEVNODE *hDevNode, + IN u32 cBufSize, + OUT char *pstrExecFile); + +/* + * ======== CFG_GetHostResources ======== + * Purpose: + * Get the Host PC allocated resources assigned to a given device. + * Parameters: + * hDevNode: Handle to the DEVNODE who's resources we are querying. + * pHostResTable: Ptr to a location to store the host resource table. + * Returns: + * DSP_SOK: On success. + * CFG_E_INVALIDPOINTER: pHostResTable is invalid. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * CFG_E_RESOURCENOTAVAIL: The resource is not available. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: pHostResTable points to a filled table of resources + * allocated for the specified WMD. + * + */ + extern DSP_STATUS CFG_GetHostResources(IN struct CFG_DEVNODE *hDevNode, + OUT struct CFG_HOSTRES *pHostResTable); + +/* + * ======== CFG_GetObject ======== + * Purpose: + * Retrieve the Driver Object handle From the Registry + * Parameters: + * pdwValue: Ptr to location to store the value. + * dwType Type of Object to Get + * Returns: + * DSP_SOK: Success. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: *pdwValue is set to the retrieved u32(non-Zero). + * else: *pdwValue is set to 0L. + */ + extern DSP_STATUS CFG_GetObject(OUT u32 *pdwValue, u32 dwType); + +/* + * ======== CFG_GetPerfValue ======== + * Purpose: + * Retrieve a flag indicating whether PERF should log statistics for the + * PM class driver. + * Parameters: + * pfEnablePerf: Location to store flag. 0 indicates the key was + * not found, or had a zero value. A nonzero value + * means the key was found and had a nonzero value. + * Returns: + * Requires: + * pfEnablePerf != NULL; + * Ensures: + */ + extern void CFG_GetPerfValue(OUT bool *pfEnablePerf); + +/* + * ======== CFG_GetWMDFileName ======== + * Purpose: + * Get the mini-driver file name for a given device. + * Parameters: + * hDevNode: Handle to the DevNode who's WMD we are querying. + * cBufSize: Size of buffer. + * pWMDFileName: Ptr to a character buffer to hold the WMD filename. + * Returns: + * DSP_SOK: On success. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * CFG_E_RESOURCENOTAVAIL: The filename is not available. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: Not more than cBufSize bytes were copied + * into pWMDFileName. + * + */ + extern DSP_STATUS CFG_GetWMDFileName(IN struct CFG_DEVNODE *hDevNode, + IN u32 cBufSize, + OUT char *pWMDFileName); + +/* + * ======== CFG_GetZLFile ======== + * Purpose: + * Retreive the ZLFile, if any, for this board. + * Parameters: + * hDevNode: Handle to the DevNode who's WMD we are querying. + * cBufSize: Size of buffer. + * pstrZLFileName: Ptr to character buf to hold ZLFileName. + * Returns: + * DSP_SOK: Success. + * CFG_E_INVALIDPOINTER: pstrZLFileName is invalid. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * CFG_E_RESOURCENOTAVAIL: couldn't find the ZLFileName. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: Not more than cBufSize bytes were copied into + * pstrZLFileName, and *pstrZLFileName contains ZLFileName + * for this devnode. + */ + extern DSP_STATUS CFG_GetZLFile(IN struct CFG_DEVNODE *hDevNode, + IN u32 cBufSize, + OUT char *pstrZLFileName); + +/* + * ======== CFG_Init ======== + * Purpose: + * Initialize the CFG module's private state. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * A requirement for each of the other public CFG functions. + */ + extern bool CFG_Init(); + +/* + * ======== CFG_SetDevObject ======== + * Purpose: + * Store the Device Object handle for a given devnode. + * Parameters: + * hDevNode: Platform's DevNode handle we are storing value with. + * dwValue: Arbitrary value to store. + * Returns: + * DSP_SOK: Success. + * CFG_E_INVALIDHDEVNODE: hDevNode is invalid. + * DSP_EFAIL: Internal Error. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: The Private u32 was successfully set. + */ + extern DSP_STATUS CFG_SetDevObject(IN struct CFG_DEVNODE *hDevNode, + IN u32 dwValue); + +/* + * ======== CFG_SetDrvObject ======== + * Purpose: + * Store the Driver Object handle. + * Parameters: + * dwValue: Arbitrary value to store. + * dwType Type of Object to Store + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Internal Error. + * Requires: + * CFG initialized. + * Ensures: + * DSP_SOK: The Private u32 was successfully set. + */ + extern DSP_STATUS CFG_SetObject(IN u32 dwValue, IN u32 dwType); + +#endif /* CFG_ */ diff --git a/arch/arm/plat-omap/include/bridge/cfgdefs.h b/arch/arm/plat-omap/include/bridge/cfgdefs.h new file mode 100644 index 0000000..c81cb1a --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/cfgdefs.h @@ -0,0 +1,127 @@ +/* + * arch/arm/plat-omap/include/bridge/cfgdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== cfgdefs.h ======== + * Purpose: + * Global CFG constants and types, shared between class and mini driver. + * + *! Revision History: + *! ================ + *! 24-Feb-2003 kc Removed wIOPort* in CFG_HOSTRES. + *! 06-Sep-2000 jeh Added channel info to CFG_HOSTRES. + *! 09-May-2000 rr: CFG_HOSTRES now support multiple windows for PCI support. + *! 31-Jan-2000 rr: Comments changed after code review. + *! 06-Jan-2000 rr: Bus Type included in CFG_HOSTRES. + *! 12-Nov-1999 rr: CFG_HOSTRES member names changed. + *! 25-Oct-1999 rr: Modified the CFG_HOSTRES Structure + *! PCMCIA ISR Register/Unregister fxn removed.. + *! New flag PCCARD introduced during compile time. + *! 10-Sep-1999 ww: Added PCMCIA ISR Register/Unregister fxn. + *! 01-Sep-1999 ag: Removed NT/95 specific fields in CFG_HOSTRES + *! 27-Oct-1997 cr: Updated CFG_HOSTRES struct to support 1+ IRQs per board. + *! 17-Sep-1997 gp: Tacked some NT config info to end of CFG_HOSTRES structure. + *! 12-Dec-1996 cr: Cleaned up after code review. + *! 14-Nov-1996 gp: Renamed from wsxcfg.h + *! 19-Jun-1996 cr: Created. + */ + +#ifndef CFGDEFS_ +#define CFGDEFS_ + +/* Maximum length of module search path. */ +#define CFG_MAXSEARCHPATHLEN 255 + +/* Maximum length of general paths. */ +#define CFG_MAXPATH 255 + +/* Host Resources: */ +#define CFG_MAXMEMREGISTERS 9 +#define CFG_MAXIOPORTS 20 +#define CFG_MAXIRQS 7 +#define CFG_MAXDMACHANNELS 7 + +/* IRQ flag */ +#define CFG_IRQSHARED 0x01 /* IRQ can be shared */ + +/* DSP Resources: */ +#define CFG_DSPMAXMEMTYPES 10 +#define CFG_DEFAULT_NUM_WINDOWS 1 /* We support only one window. */ + +/* A platform-related device handle: */ + struct CFG_DEVNODE; + +/* + * Host resource structure. + */ + struct CFG_HOSTRES { + u32 wNumMemWindows; /* Set to default */ + /* This is the base.memory */ + u32 dwMemBase[CFG_MAXMEMREGISTERS]; /* SHM virtual address */ + u32 dwMemLength[CFG_MAXMEMREGISTERS]; /* Length of the Base */ + u32 dwMemPhys[CFG_MAXMEMREGISTERS]; /* SHM Physical address */ + u8 bIRQRegisters; /* IRQ Number */ + u8 bIRQAttrib; /* IRQ Attribute */ + u32 dwOffsetForMonitor; /* The Shared memory starts from + * dwMemBase + this offset */ + u32 dwBusType; /* Bus type for this device */ + u32 dwProgBase; /* DSP ProgBase */ + u32 dwProgLength; /* DSP ProgBase Length */ + u32 dwRegBase; /* DSP memory mapped register base */ + u32 dwRegLength; /* DSP Register Base Length */ + u32 ClientHandle; /* Client Handle */ + u32 SocketHandle; /* Socket and Function Pair */ + u32 CardInfo; /* This will be used as a context data in + * in the CardRequestIRQ */ + /* + * Info needed by NODE for allocating channels to communicate with RMS: + * dwChnlOffset: Offset of RMS channels. Lower channels are + * reserved. + * dwChnlBufSize: Size of channel buffer to send to RMS + * dwNumChnls: Total number of channels (including reserved). + */ + u32 dwChnlOffset; + u32 dwChnlBufSize; + u32 dwNumChnls; + +#ifdef CONFIG_ARCH_OMAP3430 + u32 dwPrmBase; + u32 dwCmBase; + u32 dwPerBase; + u32 dwWdTimerDspBase; + u32 dwMboxBase; + u32 dwDmmuBase; + u32 dwDipiBase; + u32 dwSysCtrlBase; +#endif + } ; + + struct CFG_DSPMEMDESC { + u32 uMemType; /* Type of memory. */ + u32 ulMin; /* Minimum amount of memory of this type. */ + u32 ulMax; /* Maximum amount of memory of this type. */ + } ; + + struct CFG_DSPRES { + u32 uChipType; /* DSP chip type. */ + u32 uWordSize; /* Number of bytes in a word */ + u32 cChips; /* Number of chips. */ + u32 cMemTypes; /* Types of memory. */ + struct CFG_DSPMEMDESC aMemDesc[CFG_DSPMAXMEMTYPES]; + /* DSP Memory types */ + } ; + +#endif /* CFGDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/chnl.h b/arch/arm/plat-omap/include/bridge/chnl.h new file mode 100644 index 0000000..515a470 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/chnl.h @@ -0,0 +1,537 @@ +/* + * arch/arm/plat-omap/include/bridge/chnl.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== chnl.h ======== + * Description: + * WCD channel interface: multiplexes data streams through the single + * physical link managed by a mini-driver. + * + * Public Functions: + * CHNL_AddIOReq + * CHNL_AllocBuffer + * CHNL_CancelIO + * CHNL_Close + * CHNL_CloseOrphans + * CHNL_Create + * CHNL_Destroy + * CHNL_Exit + * CHNL_FlushIO + * CHNL_FreeBuffer + * CHNL_GetEventHandle + * CHNL_GetHandle + * CHNL_GetIOCompletion + * CHNL_GetId + * CHNL_GetMgr + * CHNL_GetMode + * CHNL_GetPosition + * CHNL_GetProcessHandle + * CHNL_Init + * CHNL_Open + * + * Notes: + * See DSP API chnl.h for more details. + * + *! Revision History: + *! ================ + *! 14-Jan-1997 gp: Updated based on code review feedback. + *! 24-Oct-1996 gp: Move CloseOrphans into here from dspsys. + *! 09-Sep-1996 gp: Added CHNL_GetProcessID() and CHNL_GetHandle(). + *! 10-Jul-1996 gp: Created. + */ + +#ifndef CHNL_ +#define CHNL_ + +#include + +/* + * ======== CHNL_AddIOReq ======== + * Purpose: + * Enqueue an I/O request for data transfer with the DSP on this channel. + * The direction (mode) is specified in the channel object. + * Parameters: + * hChnl: Channel object handle. + * pHostBuf: Host buffer address source. + * cBytes: Number of PC bytes to transfer. A zero value indicates + * that this buffer is the last in the output channel. + * A zero value is invalid for an input channel. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * DSP_EPOINTER: pHostBuf is invalid. + * CHNL_E_NOEOS: User cannot mark EOS on an input channel. + * CHNL_E_CANCELLED: I/O has been cancelled on this channel. No further + * I/O is allowed. + * CHNL_E_EOS: End of stream was already marked on a previous + * IORequest on this output channel. Not returned for + * input channels. + * CHNL_E_NOIORPS: No free IO request packets available for queuing. + * CHNL_E_BUFSIZE: Buffer submitted to this output channel is larger than + * the size of the physical shared memory output window. + * Requires: + * CHNL_Init() called. + * pHostBuf points to memory which can be safely accessed at interrupt + * time without page fault. + * Ensures: + * The buffer will be transferred if the channel is ready; otherwise, will + * be queued for transfer when the channel becomes ready. In any case, + * notifications of I/O completion are asynchronous. + * If cBytes is 0 for an output channel, subsequent CHNL_AddIOReq's on + * this channel will fail with error code CHNL_E_EOS. The corresponding + * IOC for this I/O request will have its status flag set to + * CHNL_IOCSTATEOS. + */ + extern DSP_STATUS CHNL_AddIOReq(struct CHNL_OBJECT *hChnl, + void *pHostBuf, + u32 cBytes); + +/* + * ======== CHNL_AllocBuffer ======== + * Purpose: + * Allocate a zero-initialized buffer to be used in data transfers though + * a channel managed by this channel manager. + * Parameters: + * ppBuf: Location to store buffer pointer. + * hChnlMgr: Handle to a valid channel manager. + * cBytes: Size of buffer in bytes. Must be greater than zero. + * Returns: + * DSP_SOK: Success. + * DSP_EPOINTER: ppBuf is invalid. + * DSP_EHANDLE: hChnlMgr is invalid. + * DSP_EMEMORY: Insufficient memory to allocate buffer. + * DSP_EINVALIDARG: Invalid cBytes value. + * Requires: + * CHNL_Init() called. + * Ensures: + * DSP_SOK: *ppBuf points to memory which can be accessed in + * any context. + * else: *ppBuf contains NULL if ppBuf != NULL. + */ + extern DSP_STATUS CHNL_AllocBuffer(OUT void **ppBuf, + struct CHNL_MGR *hChnlMgr, + u32 cBytes); + +/* + * ======== CHNL_CancelIO ======== + * Purpose: + * Return all I/O requests to the client which have not yet been + * transferred. The channel's I/O completion object is + * signalled, and all the I/O requests are queued as IOC's, with the + * status field set to CHNL_IOCSTATCANCEL. + * This call is typically used in abort situations, and is a prelude to + * CHNL_Close(); + * Parameters: + * hChnl: Channel object handle. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * Requires: + * CHNL_Init() called. + * Ensures: + * Subsequent I/O requests to this channel will not be accepted. + */ + extern DSP_STATUS CHNL_CancelIO(struct CHNL_OBJECT *hChnl); + +/* + * ======== CHNL_Close ======== + * Purpose: + * Ensures all pending I/O on this channel is cancelled, discards all + * queued I/O completion notifications, then frees the resources allocated + * for this channel, and makes the corresponding logical channel id + * available for subsequent use. + * Parameters: + * hChnl: Channel object handle. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * Requires: + * CHNL_Init() called. + * No thread must be blocked on this channel's I/O completion event. + * Ensures: + * DSP_SOK: The I/O completion event for this channel is freed. + * hChnl is no longer valid. + */ + extern DSP_STATUS CHNL_Close(struct CHNL_OBJECT *hChnl); + +/* + * ======== CHNL_CloseOrphans ======== + * Purpose: + * Close open channels orphaned by a closing process. + * Parameters: + * hChnlMgr: Channel manager holding the channels. + * hProcess: Kernel mode handle of the process claiming the channels. + * Returns: + * DSP_SOK: Success. + * DSP_SFALSE: No channels were left open by this process. + * DSP_EHANDLE: Invalid hChnlMgr handle. + * Requires: + * CHNL_Init() called. + * Ensures: + */ + extern DSP_STATUS CHNL_CloseOrphans(struct CHNL_MGR *hChnlMgr, + HANDLE hProcess); + +/* + * ======== CHNL_Create ======== + * Purpose: + * Create a channel manager object, responsible for opening new channels + * and closing old ones for a given board. + * Parameters: + * phChnlMgr: Location to store a channel manager object on output. + * hDevObject: Handle to a device object. + * pMgrAttrs: Channel manager attributes. + * pMgrAttrs->cChannels: Max channels + * pMgrAttrs->bIRQ: Channel's I/O IRQ number. + * pMgrAttrs->fShared: TRUE if the IRQ is shareable. + * pMgrAttrs->uWordSize: DSP Word size in equivalent PC bytes.. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: hDevObject is invalid. + * DSP_EINVALIDARG: cChannels is 0. + * DSP_EMEMORY: Insufficient memory for requested resources. + * CHNL_E_ISR: Unable to plug channel ISR for configured IRQ. + * CHNL_E_MAXCHANNELS: This manager cannot handle this many channels. + * CHNL_E_INVALIDIRQ: Invalid IRQ number. Must be 0 <= bIRQ <= 15. + * CHNL_E_INVALIDWORDSIZE: Invalid DSP word size. Must be > 0. + * CHNL_E_INVALIDMEMBASE: Invalid base address for DSP communications. + * CHNL_E_MGREXISTS: Channel manager already exists for this device. + * Requires: + * CHNL_Init() called. + * phChnlMgr != NULL. + * pMgrAttrs != NULL. + * Ensures: + * DSP_SOK: Subsequent calls to CHNL_Create() for the same + * board without an intervening call to + * CHNL_Destroy() will fail. + */ + extern DSP_STATUS CHNL_Create(OUT struct CHNL_MGR **phChnlMgr, + struct DEV_OBJECT *hDevObject, + IN CONST struct CHNL_MGRATTRS *pMgrAttrs); + +/* + * ======== CHNL_Destroy ======== + * Purpose: + * Close all open channels, and destroy the channel manager. + * Parameters: + * hChnlMgr: Channel manager object. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: hChnlMgr was invalid. + * Requires: + * CHNL_Init() called. + * Ensures: + * DSP_SOK: Cancels I/O on each open channel. + * Closes each open channel. + * CHNL_Create may subsequently be called for the + * same board. + */ + extern DSP_STATUS CHNL_Destroy(struct CHNL_MGR *hChnlMgr); + +/* + * ======== CHNL_Exit ======== + * Purpose: + * Discontinue usage of the CHNL module. + * Parameters: + * Returns: + * Requires: + * CHNL_Init() previously called. + * Ensures: + * Resources, if any acquired in CHNL_Init(), are freed when the last + * client of CHNL calls CHNL_Exit(). + */ + extern void CHNL_Exit(); + +/* + * ======== CHNL_FlushIO ======== + * Purpose: + * For an output stream (to the DSP), flush all pending IO requests to the + * output device. This function will wait for IO completion for each of + * the queued IO requests, up to the specified timeout (per IOR). For + * input streams (from the DSP), will cancel all pending IO requests. + * Parameters: + * hChnl: Channel object handle. + * dwTimeOut: Timeout in milliseconds to wait for I/O completion. + * A value of CHNL_IOCINFINITE means to wait indefinitely. + * The value of CHNL_IOCNOWAIT is not allowed. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * DSP_EINVALIDARG: dwTimeOut value of CHNL_IOCNOWAIT was given. + * CHNL_E_WAITTIMEOUT: Wait for flush of output stream timed out. + * Requires: + * CHNL_Init() called. + * Ensures: + * DSP_SOK: No I/O requests will be pending on this channel. + */ + extern DSP_STATUS CHNL_FlushIO(struct CHNL_OBJECT *hChnl, + u32 dwTimeOut); + +/* + * ======== CHNL_FreeBuffer ======== + * Purpose: + * Free a buffer previously allocated using CHNL_AllocBuffer(). + * Parameters: + * hChnlMgr: Handle to a valid channel manager. + * cBytes: Size of buffer in bytes. + * pBuf: Buffer pointer returned by CHNL_FreeBuffer(). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: hChnlMgr is invalid. + * DSP_EINVALIDARG: pBuf is NULL. + * Requires: + * CHNL_Init() called. + * Ensures: + */ + extern DSP_STATUS CHNL_FreeBuffer(struct CHNL_MGR *hChnlMgr, + u32 cBytes, + void *pBuf); + +/* + * ======== CHNL_GetEventHandle ======== + * Purpose: + * Retrieve this channel's I/O completion auto-reset event. + * Parameters: + * hChnl: Handle to a valid channel object. + * phEvent: Location to store the I/O completion event object. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * DSP_EPOINTER: phEvent is invalid. + * Requires: + * CHNL_Init() called. + + */ + extern DSP_STATUS CHNL_GetEventHandle(struct CHNL_OBJECT *hChnl, + OUT HANDLE *phEvent); + +/* + * ======== CHNL_GetHandle ======== + * Purpose: + * Retrieve the channel handle given the logical ID and channel manager. + * Parameters: + * hChnlMgr: Handle to a valid channel manager, or NULL. + * uChnlID: Channel ID. + * phChnl: Location to store channel handle. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnlMgr. + * DSP_EPOINTER: phChnl == NULL. + * CHNL_E_BADCHANID: Invalid channel ID. + * Requires: + * CHNL_Init() called. + * Ensures: + * DSP_SOK: *phChnl points to a valid channel object, + * if phChnl != NULL. + */ + extern DSP_STATUS CHNL_GetHandle(struct CHNL_MGR *hChnlMgr, + u32 uChnlID, + OUT struct CHNL_OBJECT **phChnl); + +/* + * ======== CHNL_GetIOCompletion ======== + * Purpose: + * Optionally wait for I/O completion on a channel. Dequeue an I/O + * completion record, which contains information about the completed + * I/O request. + * Parameters: + * hChnl: Channel object handle. + * dwTimeOut: Timeout in milliseconds to wait for completion. + * A value of CHNL_IOCINFINITE means to wait indefinitely. + * A value of CHNL_IOCNOWAIT will simply dequeue the + * first available IOC. + * pIOC: On output, contains host buffer address, bytes + * transferred, and status of I/O completion. + * pIOC->status: I/O Completion status: see chnldefs.h for definitions. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hChnl. + * DSP_EPOINTER: pIOC is invalid. + * CHNL_E_NOIOC: CHNL_IOCNOWAIT was specified as the dwTimeOut parameter + * yet no I/O completions were queued. + * Requires: + * CHNL_Init() called. + * Ensures: + * DSP_SOK: If there are any remaining IOC's queued before this + * call returns, the channel event object will be left + * in a signalled state. + * If the return status is anything other than DSP_EPOINTER or DSP_SOK, + * then pIOC->pBuf will be set to NULL, pIOC->cBytes will be 0, and + * pIOC->status will be undefined. + */ + extern DSP_STATUS CHNL_GetIOCompletion(struct CHNL_OBJECT *hChnl, + u32 dwTimeOut, + OUT struct CHNL_IOC *pIOC); + +/* + * ======== CHNL_GetId ======== + * Purpose: + * Retrieve the channel logical ID of this channel. + * Parameters: + * hChnl: Handle to a valid channel object. + * pdwID: Location to store logical ID. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * DSP_EPOINTER: pdwID is invalid. + * Requires: + * CHNL_Init() called. + * Ensures: + */ + extern DSP_STATUS CHNL_GetId(struct CHNL_OBJECT *hChnl, + OUT u32 *pdwID); + +/* + * ======== CHNL_GetMgr ======== + * Purpose: + * Retrieve a channel manager handle, required for opening new channels + * and closing old ones on a given board. + * Parameters: + * hDevNode: A valid system specific DEVNODE handle. + * phChnlMgr: Location to store the channel manager handle on output. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: hDevNode is invalid. + * CHNL_E_NOMGR: No channel manager exists for this board. + * Requires: + * CHNL_Init() called. + * phChnlMgr != NULL. + * Ensures: + * DSP_SOK: The DSP board represented by hDevNode was in the RUNNING state + * before this function returned. + * else: *phChnlMgr == NULL. + */ + extern DSP_STATUS CHNL_GetMgr(struct CFG_DEVNODE *hDevNode, + OUT struct CHNL_MGR **phChnlMgr); + +/* + * ======== CHNL_GetMode ======== + * Purpose: + * Retrieve the mode flags of this channel. + * Parameters: + * hChnl: Handle to a valid channel object. + * pMode: Location to store mode flags. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * DSP_EPOINTER: pMode is invalid. + * Requires: + * CHNL_Init() called. + * Ensures: + */ + extern DSP_STATUS CHNL_GetMode(struct CHNL_OBJECT *hChnl, + OUT CHNL_MODE * pMode); + +/* + * ======== CHNL_GetPosition ======== + * Purpose: + * Retrieve the total number of bytes transferred on this channel. + * Parameters: + * hChnl: Handle to a valid channel object. + * pcPosition: Location to store number of bytes. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * DSP_EPOINTER: pcPosition is invalid. + * Requires: + * CHNL_Init() called. + * Ensures: + */ + extern DSP_STATUS CHNL_GetPosition(struct CHNL_OBJECT *hChnl, + OUT u32 *pcPosition); + +/* + * ======== CHNL_GetProcessHandle ======== + * Purpose: + * Retrieve the handle of the process owning this channel. + * Parameters: + * hChnl: Channel handle. + * phProcess: Location to store the process handle. A NULL value + * indicates the channel is either closed or is not + * owned by any particular process. + * Returns: + * DSP_SOK: Success; + * DSP_EHANDLE: Invalid hChnl. + * DSP_EPOINTER: phProcess is invalid. + * Requires: + * CHNL_Init() called. + * Ensures: + */ + extern DSP_STATUS CHNL_GetProcessHandle(struct CHNL_OBJECT *hChnl, + OUT HANDLE *phProcess); + +/* + * ======== CHNL_Init ======== + * Purpose: + * Initialize the CHNL module's private state. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occurred. + * Requires: + * Ensures: + * A requirement for each of the other public CHNL functions. + */ + extern bool CHNL_Init(); + +/* + * ======== CHNL_Open ======== + * Purpose: + * Open a new half-duplex channel to the DSP board. + * Parameters: + * phChnl: Location to store a channel object handle. + * hChnlMgr: Handle to channel manager, as returned by CHNL_GetMgr(). + * uMode: One of {CHNL_MODETODSP, CHNL_MODEFROMDSP} specifies + * direction of data transfer. + * uChnlId: If CHNL_PICKFREE is specified, the channel manager will + * select a free channel id (default); + * otherwise this field specifies the id of the channel. + * pAttrs: Channel attributes. Attribute fields are as follows: + * pAttrs->uIOReqs: Specifies the maximum number of I/O requests which can + * be pending at any given time. All request packets are + * preallocated when the channel is opened. + * pAttrs->hEvent: This field allows the user to supply an auto reset + * event object for channel I/O completion notifications. + * It is the responsibility of the user to destroy this + * object AFTER closing the channel. + * This channel event object can be retrieved using + * CHNL_GetEventHandle(). + * pAttrs->hReserved: The kernel mode handle of this event object. + * + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: hChnlMgr is invalid. + * DSP_EMEMORY: Insufficient memory for requested resources. + * DSP_EINVALIDARG: Invalid number of IOReqs. + * CHNL_E_BADMODE: Invalid mode argument. + * CHNL_E_OUTOFSTREAMS: No free channels available. + * CHNL_E_BADCHANID: Channel ID is out of range. + * CHNL_E_CHANBUSY: Channel is in use. + * Requires: + * CHNL_Init() called. + * phChnl != NULL. + * pAttrs != NULL. + * pAttrs->hEvent is a valid event handle. + * Ensures: + * DSP_SOK: *phChnl is a valid channel. + * else: *phChnl is set to NULL if (phChnl != NULL); + */ + extern DSP_STATUS CHNL_Open(OUT struct CHNL_OBJECT **phChnl, + struct CHNL_MGR *hChnlMgr, CHNL_MODE uMode, + u32 uChnlId, + CONST IN struct CHNL_ATTRS *pAttrs); + +#endif /* CHNL_ */ diff --git a/arch/arm/plat-omap/include/bridge/chnl_sm.h b/arch/arm/plat-omap/include/bridge/chnl_sm.h new file mode 100644 index 0000000..4db08b3 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/chnl_sm.h @@ -0,0 +1,210 @@ +/* + * dspbridge/inc/chnl_sm.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== chnl_sm.h ======== + * Description: + * Prototypes for channel lower edge functions for a WinBRIDGE mini driver + * implementing data transfer via shared memory. + * + * Public Functions: + * CHNLSM_DisableInterrupt; + * CHNLSM_DPC; + * CHNLSM_EnableInterrupt; + * CHNLSM_InterruptDSP; + * CHNLSM_ISR; + * CHNLSM_Read; + * CHNLSM_UpdateSHMLength; + * CHNLSM_Write; + * + * Notes: + * These lower edge functions must be implemented by the WMD writer. + * Currently, CHNLSM_Read() and CHNLSM_Write() are not called, but must + * be defined to link. + * + *! Revision History: + *! ================ + *! 06-Jan-2002 ag: Added CHNLSM_InterruptDSP2 to set Mailbox value. + *! 05-Nov-2001 kc: Updated CHNLSM_ISR to read value returned by interrupt. + *! 21-Jan-2000 ag: Updated comments per code review. + *! 18-Dec-1997 gp: Added CDECL. + *! 16-Jun-1997 gp: Added function UpdateSHMLength(). + *! 13-Nov-1996 gp: Renamed CHNL_ to CHNLSM_. + *! 10-Jul-1996 gp: Created. + */ + +#ifndef CHNLSM_ +#define CHNLSM_ + +#include + +/* + * ======== CHNLSM_DisableInterrupt ======== + * Purpose: + * Disable interrupts from the DSP board to the PC. + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * Returns: + * Requires: + * Ensures: + */ + extern DSP_STATUS CDECL CHNLSM_DisableInterrupt(struct WMD_DEV_CONTEXT* + hDevContext); + +/* + * ======== CHNLSM_DPC ======== + * Purpose: + * This mini-driver's deferred processing routine. Finishes processing + * deferred by the WMD's ISR. + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * Returns: + * Requires: + * Must not block. + * Must not acquire resources. + * All data objects touched must be locked in memory. + * Ensures: + */ + extern void CDECL CHNLSM_DPC(struct WMD_DEV_CONTEXT *hDevContext); + +/* + * ======== CHNLSM_EnableInterrupt ======== + * Purpose: + * Enable interrupts from the DSP board to the PC. + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * Returns: + * Requires: + * Ensures: + */ + extern DSP_STATUS CDECL CHNLSM_EnableInterrupt(struct WMD_DEV_CONTEXT* + hDevContext); + +/* + * ======== CHNLSM_InterruptDSP ======== + * Purpose: + * Send an interrupt to the DSP processor(s). + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * Returns: + * DSP_SOK: Interrupt sent; + * else: Unable to send interrupt. + * Requires: + * Ensures: + */ + extern DSP_STATUS CDECL CHNLSM_InterruptDSP(struct WMD_DEV_CONTEXT* + hDevContext); + +/* + * ======== CHNLSM_InterruptDSP2 ======== + * Purpose: + * Set interrupt value & send an interrupt to the DSP processor(s). + * This is typicaly used when mailbox interrupt mechanisms allow data + * to be associated with interrupt such as for OMAP's CMD/DATA regs. + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * wMbVal: Value associated with interrupt(e.g. mailbox value). + * Returns: + * DSP_SOK: Interrupt sent; + * else: Unable to send interrupt. + * Requires: + * Ensures: + */ + extern DSP_STATUS CDECL CHNLSM_InterruptDSP2(struct WMD_DEV_CONTEXT* + hDevContext, u16 wMbVal); + +/* + * ======== CHNLSM_ISR ======== + * Purpose: + * Mini-driver's ISR, called by WCD when the board interrupts the host. + * Parameters: + * hDevContext: Handle to the mini-driver defined device info. + * pfSchedDPC: Set to TRUE to schedule a deferred procedure call + * to advance the channel protocol. The channel class + * library will call the WMD's CHNLSM_DPC routine during + * its own DPC, before dispatching I/O. + * The channel class library should ignore *pfSchedDPC when + * CHNLSM_ISR returns FALSE. + * pwMBRegVal: Value of mailbox register. + * Returns: + * TRUE if this interrupt is was generated by the DSP board. + * FALSE otherwise. + * Requires: + * Interrupts to the host processor are disabled on entry. + * Must only call functions which are in page locked memory. + * Must only call asynchronous OS services. + * The EOI for this interrupt has already been sent to the PIC. + * Ensures: + * If the interrupt is *not* shared, this routine must return TRUE. + */ + extern bool CDECL CHNLSM_ISR(struct WMD_DEV_CONTEXT *hDevContext, + OUT bool *pfSchedDPC, + OUT u16 *pwIntrVal); + +/* + * ======== CHNLSM_Read ======== + * Purpose: + * Read data from DSP board memory into a Host buffer. + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * pHostBuf: Pointer to host buffer (Destination). + * dwDSPAddr: Address on DSP board (Source). + * ulNumBytes: Number of bytes to transfer. + * Returns: + * Requires: + * Ensures: + */ + extern DSP_STATUS CDECL CHNLSM_Read(struct WMD_DEV_CONTEXT *hDevContext, + OUT u8 *pHostBuf, + u32 dwDSPAddr, u32 ulNumBytes); + +/* + * ======== CHNLSM_UpdateSHMLength ======== + * Purpose: + * Allow the minidriver a chance to override the SHM length as reported + * to the mini driver (chnl_sm.lib) by Windows Plug and Play. + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * pSHMLength: Pointer to size of SHM window (in DSP words). + * Returns: + * TRUE if pSHMLength updated; FALSE otherwise. + * Requires: + * pSHMLength != NULL. + * Ensures: + * No more than sizeof(u32) bytes written to *pSHMLength + */ + extern bool CHNLSM_UpdateSHMLength(struct WMD_DEV_CONTEXT *hDevContext, + IN OUT u32 *pSHMLength); + +/* + * ======== CHNLSM_Write ======== + * Purpose: + * Write data from a Host buffer to DSP board memory. + * Parameters: + * hDevContext: Handle to mini-driver defined device info. + * pHostBuf: Pointer to host buffer (Source). + * dwDSPAddr: Address on DSP board (Destination). + * ulNumBytes: Number of bytes to transfer. + * Returns: + * Requires: + * Ensures: + */ + extern DSP_STATUS CDECL CHNLSM_Write(struct WMD_DEV_CONTEXT *hDevContext, + IN u8 *pHostBuf, + u32 dwDSPAddr, u32 ulNumBytes); + +#endif /* CHNLSM_ */ diff --git a/arch/arm/plat-omap/include/bridge/chnldefs.h b/arch/arm/plat-omap/include/bridge/chnldefs.h new file mode 100644 index 0000000..0e72431 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/chnldefs.h @@ -0,0 +1,92 @@ +/* + * arch/arm/plat-omap/include/bridge/chnldefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== chnldefs.h ======== + * Purpose: + * System-wide channel objects and constants. + * + *! Revision History: + *! ================ + *! 19-Jan-2002 ag Added cBufSize to IOC. + *! 05-Jan-2000 ag: Text format cleanup. + *! 02-Dec-1999 ag: Added new chnl attribute pstrEventName. + *! 12-Nov-1999 kc: Enabled hEvent attribute for tests. + *! 01-Nov-1999 ag: hEvent attribute not supported(yet). + *! 16-Jan-1997 gp: Moved private stuff into chnlpriv.h + *! 14-Jan-1997 gp: Updated based on code review feedback: + *! Removed CHNL_MODENOWAIT, CHNL_MODEDIRECT, + *! 03-Jan-1997 gp: Added channel class library types. + *! 14-Dec-1996 gp: Moved uChnlId field from CHNL_ATTRS to CHNL_Open(). + *! 10-Dec-1996 gp: Added CHNL_IsTimedOut() macro. + *! 14-Nov-1996 gp: Renamed from wsxchnl.h. + *! 09-Sep-1996 gp: Added hReserved2 field to CHNL_ATTRS. Updated CHNL_INFO. + *! 10-Jul-1996 gp: Created from channel.h. + */ + +#ifndef CHNLDEFS_ +#define CHNLDEFS_ + +/* Channel id option. */ +#define CHNL_PICKFREE (~0UL) /* Let manager pick a free channel. */ + +/* Channel manager limits: */ +#define CHNL_INITIOREQS 4 /* Default # of I/O requests. */ + +/* Channel modes */ +#define CHNL_MODETODSP 0x0000 /* Data streaming to the DSP. */ +#define CHNL_MODEFROMDSP 0x0001 /* Data streaming from the DSP. */ + +/* GetIOCompletion flags */ +#define CHNL_IOCINFINITE 0xffffffff /* Wait forever for IO completion. */ +#define CHNL_IOCNOWAIT 0x0 /* Dequeue an IOC, if available. */ + +/* IO Completion Record status: */ +#define CHNL_IOCSTATCOMPLETE 0x0000 /* IO Completed. */ +#define CHNL_IOCSTATCANCEL 0x0002 /* IO was cancelled */ +#define CHNL_IOCSTATTIMEOUT 0x0008 /* Wait for IOC timed out. */ +#define CHNL_IOCSTATEOS 0x8000 /* End Of Stream reached. */ + +/* Macros for checking I/O Completion status: */ +#define CHNL_IsEOS(ioc) (ioc.status & CHNL_IOCSTATEOS) +#define CHNL_IsIOComplete(ioc) (!(ioc.status & ~CHNL_IOCSTATEOS)) +#define CHNL_IsIOCancelled(ioc) (ioc.status & CHNL_IOCSTATCANCEL) +#define CHNL_IsTimedOut(ioc) (ioc.status & CHNL_IOCSTATTIMEOUT) + +/* CHNL types: */ + typedef u32 CHNL_MODE; /* Channel transfer mode. */ + +/* Channel attributes: */ + struct CHNL_ATTRS { + u32 uIOReqs; /* Max # of preallocated I/O requests. */ + HANDLE hEvent; /* User supplied auto-reset event object. */ + char *pstrEventName; /* Ptr to name of user event object. */ + HANDLE hReserved1; /* Reserved for future use. */ + u32 hReserved2; /* Reserved for future use. */ + + }; + +/* I/O completion record: */ + struct CHNL_IOC { + void *pBuf; /* Buffer to be filled/emptied. */ + u32 cBytes; /* Bytes transferred. */ + u32 cBufSize; /* Actual buffer size in bytes */ + u32 status; /* Status of IO completion. */ + u32 dwArg; /* User argument associated with pBuf. */ + } ; + +#endif /* CHNLDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/chnlpriv.h b/arch/arm/plat-omap/include/bridge/chnlpriv.h new file mode 100644 index 0000000..a49f971 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/chnlpriv.h @@ -0,0 +1,136 @@ +/* + * arch/arm/plat-omap/include/bridge/chnlpriv.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== chnlpriv.h ======== + * Description: + * Private channel header shared between DSPSYS, WCD and WMD modules. + * + * Public Functions: + * None. + * + * Notes: + * + *! Revision History: + *! ================ + *! 05-Jan-2002 ag Added cChannels(total # of chnls) to CHNL_MGRINFO struct. + *! Added private CHNL_[PCPY][ZCPY][DDMA]. + *! 17-Nov-2000 jeh Removed IRQ, shared memory from CHNL_MGRATTRS, since these + *! now belong to IO_ATTRS. + *! 21-Jan-2000 ag: Code review comments added. + *! 05-Jan-2000 ag: Text format cleanup. + *! 11-Dec-1999 ag: Added CHNL_MAXLOCKPAGES for CHNL_PrepareBuffer(). + *! 04-Dec-1999 ag: Added CHNL_MAXEVTNAMELEN for i/o compl named event support. + *! 01-Nov-1999 ag: CHNL_MAXCHANNELS set to 16 for 16-bit DSPs. + *! 27-Oct-1997 cr: Expanded CHNL_MAXIRQ from 0x0f to 0xff. + *! 16-Jan-1997 gp: Moved symbols into here from chnldefs.h. + *! 03-Jan-1997 gp: Added CHNL_MAXIRQ define. + *! 09-Dec-1996 gp: Removed CHNL_STATEIDLE. + *! 15-Jul-1996 gp: Created. + */ + +#ifndef CHNLPRIV_ +#define CHNLPRIV_ + +#include +#include +#include + +/* CHNL Object validation signatures: */ +#define CHNL_MGRSIGNATURE 0x52474D43 /* "CMGR" (in reverse). */ +#define CHNL_SIGNATURE 0x4C4E4843 /* "CHNL" (in reverse). */ + +/* Channel manager limits: */ +#define CHNL_MAXCHANNELS 32 /* Max channels available per transport */ + + +/* + * Trans port channel Id definitions:(must match dsp-side). + * + * For CHNL_MAXCHANNELS = 16: + * + * ChnlIds: + * 0-15 (PCPY) - transport 0) + * 16-31 (DDMA) - transport 1) + * 32-47 (ZCPY) - transport 2) + */ +#define CHNL_PCPY 0 /* Proc-copy transport 0 */ + +#define CHNL_MAXIRQ 0xff /* Arbitrarily large number. */ + +/* The following modes are private: */ +#define CHNL_MODEUSEREVENT 0x1000 /* User provided the channel event. */ +#define CHNL_MODEMASK 0x1001 + +/* Higher level channel states: */ +#define CHNL_STATEREADY 0x0000 /* Channel ready for I/O. */ +#define CHNL_STATECANCEL 0x0001 /* I/O was cancelled. */ +#define CHNL_STATEEOS 0x0002 /* End Of Stream reached. */ + +/* Determine if user supplied an event for this channel: */ +#define CHNL_IsUserEvent(mode) (mode & CHNL_MODEUSEREVENT) + +/* Macros for checking mode: */ +#define CHNL_IsInput(mode) (mode & CHNL_MODEFROMDSP) +#define CHNL_IsOutput(mode) (!CHNL_IsInput(mode)) + +/* Types of channel class libraries: */ +#define CHNL_TYPESM 1 /* Shared memory driver. */ +#define CHNL_TYPEBM 2 /* Bus Mastering driver. */ + +/* Max string length of channel I/O completion event name - change if needed */ +#define CHNL_MAXEVTNAMELEN 32 + +/* Max memory pages lockable in CHNL_PrepareBuffer() - change if needed */ +#define CHNL_MAXLOCKPAGES 64 + +/* Channel info. */ + struct CHNL_INFO { + struct CHNL_MGR *hChnlMgr; /* Owning channel manager. */ + u32 dwID; /* Channel ID. */ + HANDLE hEvent; /* Channel I/O completion event. */ + /*Abstraction of I/O completion event.*/ + struct SYNC_OBJECT *hSyncEvent; + u32 dwMode; /* Channel mode. */ + u32 dwState; /* Current channel state. */ + u32 cPosition; /* Total bytes transferred. */ + u32 cIOCs; /* Number of IOCs in queue. */ + u32 cIOReqs; /* Number of IO Requests in queue. */ + HANDLE hProcess; /* Process owning this channel. */ + /* + * Name of channel I/O completion event. Not required in Linux + */ + char szEventName[CHNL_MAXEVTNAMELEN + 1]; + } ; + +/* Channel manager info: */ + struct CHNL_MGRINFO { + u32 dwType; /* Type of channel class library. */ + /* Channel handle, given the channel id. */ + struct CHNL_OBJECT *hChnl; + u32 cOpenChannels; /* Number of open channels. */ + u32 cChannels; /* total # of chnls supported */ + } ; + +/* Channel Manager Attrs: */ + struct CHNL_MGRATTRS { + /* Max number of channels this manager can use. */ + u32 cChannels; + u32 uWordSize; /* DSP Word size. */ + } ; + +#endif /* CHNLPRIV_ */ diff --git a/arch/arm/plat-omap/include/bridge/clk.h b/arch/arm/plat-omap/include/bridge/clk.h new file mode 100644 index 0000000..b2bf366 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/clk.h @@ -0,0 +1,155 @@ +/* + * arch/arm/plat-omap/include/bridge/clk.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== clk.h ======== + * Purpose: Provides Clock functions. + * + *! Revision History: + *! ================ + *! 08-May-2007 rg: Moved all clock functions from sync module. + */ + +#ifndef _CLK_H +#define _CLK_H + + /* Generic TIMER object: */ + struct TIMER_OBJECT; + enum SERVICES_ClkId { + SERVICESCLK_iva2_ck = 0, + SERVICESCLK_mailbox_ick, + SERVICESCLK_gpt5_fck, + SERVICESCLK_gpt5_ick, + SERVICESCLK_gpt6_fck, + SERVICESCLK_gpt6_ick, + SERVICESCLK_gpt7_fck, + SERVICESCLK_gpt7_ick, + SERVICESCLK_gpt8_fck, + SERVICESCLK_gpt8_ick, + SERVICESCLK_wdt3_fck, + SERVICESCLK_wdt3_ick, + SERVICESCLK_mcbsp1_fck, + SERVICESCLK_mcbsp1_ick, + SERVICESCLK_mcbsp2_fck, + SERVICESCLK_mcbsp2_ick, + SERVICESCLK_mcbsp3_fck, + SERVICESCLK_mcbsp3_ick, + SERVICESCLK_mcbsp4_fck, + SERVICESCLK_mcbsp4_ick, + SERVICESCLK_mcbsp5_fck, + SERVICESCLK_mcbsp5_ick, + SERVICESCLK_ssi_fck, + SERVICESCLK_ssi_ick, + SERVICESCLK_sys_32k_ck, + SERVICESCLK_sys_ck, + SERVICESCLK_NOT_DEFINED + } ; + +/* + * ======== CLK_Exit ======== + * Purpose: + * Discontinue usage of module; free resources when reference count + * reaches 0. + * Parameters: + * Returns: + * Requires: + * CLK initialized. + * Ensures: + * Resources used by module are freed when cRef reaches zero. + */ + extern void CLK_Exit(); + +/* + * ======== CLK_Init ======== + * Purpose: + * Initializes private state of CLK module. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * CLK initialized. + */ + extern bool CLK_Init(); + + +/* + * ======== CLK_Enable ======== + * Purpose: + * Enables the clock requested. + * Parameters: + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Error occured while enabling the clock. + * Requires: + * Ensures: + */ + extern DSP_STATUS CLK_Enable(IN enum SERVICES_ClkId clk_id); + +/* + * ======== CLK_Disable ======== + * Purpose: + * Disables the clock requested. + * Parameters: + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Error occured while disabling the clock. + * Requires: + * Ensures: + */ + extern DSP_STATUS CLK_Disable(IN enum SERVICES_ClkId clk_id); + +/* + * ======== CLK_GetRate ======== + * Purpose: + * Get the clock rate of requested clock. + * Parameters: + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Error occured while Getting the clock rate. + * Requires: + * Ensures: + */ + extern DSP_STATUS CLK_GetRate(IN enum SERVICES_ClkId clk_id, + u32 *speedMhz); +/* + * ======== CLK_Set_32KHz ======== + * Purpose: + * Set the requested clock to 32KHz. + * Parameters: + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Error occured while setting the clock parent to 32KHz. + * Requires: + * Ensures: + */ + extern DSP_STATUS CLK_Set_32KHz(IN enum SERVICES_ClkId clk_id); + extern void SSI_Clk_Prepare(bool FLAG); + +/* + * ======== CLK_Get_RefCnt ======== + * Purpose: + * get the reference count for the clock. + * Parameters: + * Returns: + * s32: Reference Count for the clock. + * DSP_EFAIL: Error occured while getting the reference count of a clock. + * Requires: + * Ensures: + */ + extern s32 CLK_Get_UseCnt(IN enum SERVICES_ClkId clk_id); + +#endif /* _SYNC_H */ diff --git a/arch/arm/plat-omap/include/bridge/cmm.h b/arch/arm/plat-omap/include/bridge/cmm.h new file mode 100644 index 0000000..e9792d7 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/cmm.h @@ -0,0 +1,420 @@ +/* + * arch/arm/plat-omap/include/bridge/cmm.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== cmm.h ======== + * Purpose: + * The Communication Memory Management(CMM) module provides shared memory + * management services for DSP/BIOS Bridge data streaming and messaging. + * Multiple shared memory segments can be registered with CMM. Memory is + * coelesced back to the appropriate pool when a buffer is freed. + * + * The CMM_Xlator[xxx] functions are used for node messaging and data + * streaming address translation to perform zero-copy inter-processor + * data transfer(GPP<->DSP). A "translator" object is created for a node or + * stream object that contains per thread virtual address information. This + * translator info is used at runtime to perform SM address translation + * to/from the DSP address space. + * + * + * Public Functions: + * CMM_CallocBuf + * CMM_Create + * CMM_Destroy + * CMM_Exit + * CMM_FreeBuf + * CMM_GetHandle + * CMM_GetInfo + * CMM_Init + * CMM_RegisterGPPSMSeg + * CMM_UnRegisterGPPSMSeg + * CMM_XlatorAllocBuf (Note #1 below) + * CMM_XlatorCreate " + * CMM_XlatorDelete " + * CMM_XlatorFreeBuf " + * CMM_XlatorTranslate " + * + * + * Notes: + * #1: Used by Node and Stream modules for SM address translation. + * + *! Revision History: + *! ================ + *! 30-Jan-2002 ag Removed unused CMM_Alloc[Free]Desc & CMM_XlatorRegisterPa. + *! Renamed CMM_AllocBuf() to CMM_CallocBuf(). + *! 29-Aug-2001 ag: Added dsp virt base and size to CMM_RegisterGPPSMSeg(). + *! 12-Aug-2001 ag: Added CMM_UnRegisterGPP[DSP}SMSeg[s](). + *! 05-Dec-2000 ag: Added param to CMM_XlatorDelete() to force buf cleanup. + *! 30-Oct-2000 ag: Added conversion factor to CMM_RegisterDSP[GPP]SMSeg(). + *! 12-Oct-2000 ag: Added CMM_Xlator[xxx] functions. + *! 10-Aug-2000 ag: Created. + *! + */ + +#ifndef CMM_ +#define CMM_ + +#include + +#include +#include + +/* + * ======== CMM_CallocBuf ======== + * Purpose: + * Allocate memory buffers that can be used for data streaming or + * messaging. + * Parameters: + * hCmmMgr: Cmm Mgr handle. + * uSize: Number of bytes to allocate. + * pAttr: Attributes of memory to allocate. + * ppBufVA: Address of where to place VA. + * Returns: + * Pointer to a zero'd block of SM memory; + * NULL if memory couldn't be allocated, + * or if cBytes == 0, + * Requires: + * Valid hCmmMgr. + * CMM initialized. + * Ensures: + * The returned pointer, if not NULL, points to a valid memory block of + * the size requested. + * + */ + extern void *CMM_CallocBuf(struct CMM_OBJECT *hCmmMgr, + u32 uSize, struct CMM_ATTRS *pAttrs, + OUT void **ppBufVA); + +/* + * ======== CMM_Create ======== + * Purpose: + * Create a communication memory manager object. + * Parameters: + * phCmmMgr: Location to store a communication manager handle on output. + * hDevObject: Handle to a device object. + * pMgrAttrs: Comm mem manager attributes. + * Returns: + * DSP_SOK: Success; + * DSP_EMEMORY: Insufficient memory for requested resources. + * DSP_EFAIL: Failed to initialize critical sect sync object. + * + * Requires: + * CMM_Init() called. + * phCmmMgr != NULL. + * pMgrAttrs->ulMinBlockSize >= 4 bytes. + * Ensures: + * + */ + extern DSP_STATUS CMM_Create(OUT struct CMM_OBJECT **phCmmMgr, + struct DEV_OBJECT *hDevObject, + IN CONST struct CMM_MGRATTRS *pMgrAttrs); + +/* + * ======== CMM_Destroy ======== + * Purpose: + * Destroy the communication memory manager object. + * Parameters: + * hCmmMgr: Cmm Mgr handle. + * bForce: Force deallocation of all cmm memory immediately if set TRUE. + * If FALSE, and outstanding allocations will return DSP_EFAIL + * status. + * Returns: + * DSP_SOK: CMM object & resources deleted. + * DSP_EFAIL: Unable to free CMM object due to outstanding allocation. + * DSP_EHANDLE: Unable to free CMM due to bad handle. + * Requires: + * CMM is initialized. + * hCmmMgr != NULL. + * Ensures: + * Memory resources used by Cmm Mgr are freed. + */ + extern DSP_STATUS CMM_Destroy(struct CMM_OBJECT *hCmmMgr, bool bForce); + +/* + * ======== CMM_Exit ======== + * Purpose: + * Discontinue usage of module. Cleanup CMM module if CMM cRef reaches zero. + * Parameters: + * n/a + * Returns: + * n/a + * Requires: + * CMM is initialized. + * Ensures: + */ + extern void CMM_Exit(); + +/* + * ======== CMM_FreeBuf ======== + * Purpose: + * Free the given buffer. + * Parameters: + * hCmmMgr: Cmm Mgr handle. + * pBuf: Pointer to memory allocated by CMM_CallocBuf(). + * ulSegId: SM segment Id used in CMM_Calloc() attrs. + * Set to 0 to use default segment. + * Returns: + * DSP_SOK + * DSP_EFAIL + * Requires: + * CMM initialized. + * pBufPA != NULL + * Ensures: + * + */ + extern DSP_STATUS CMM_FreeBuf(struct CMM_OBJECT *hCmmMgr, + void *pBufPA, u32 ulSegId); + +/* + * ======== CMM_GetHandle ======== + * Purpose: + * Return the handle to the cmm mgr for the given device obj. + * Parameters: + * hProcessor: Handle to a Processor. + * phCmmMgr: Location to store the shared memory mgr handle on output. + * + * Returns: + * DSP_SOK: Cmm Mgr opaque handle returned. + * DSP_EHANDLE: Invalid handle. + * Requires: + * phCmmMgr != NULL + * hDevObject != NULL + * Ensures: + */ + extern DSP_STATUS CMM_GetHandle(DSP_HPROCESSOR hProcessor, + OUT struct CMM_OBJECT **phCmmMgr); + +/* + * ======== CMM_GetInfo ======== + * Purpose: + * Return the current SM and VM utilization information. + * Parameters: + * hCmmMgr: Handle to a Cmm Mgr. + * pCmmInfo: Location to store the Cmm information on output. + * + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid handle. + * DSP_EINVALIDARG Invalid input argument. + * Requires: + * Ensures: + * + */ + extern DSP_STATUS CMM_GetInfo(struct CMM_OBJECT *hCmmMgr, + OUT struct CMM_INFO *pCmmInfo); + +/* + * ======== CMM_Init ======== + * Purpose: + * Initializes private state of CMM module. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * CMM initialized. + */ + extern bool CMM_Init(); + +/* + * ======== CMM_RegisterGPPSMSeg ======== + * Purpose: + * Register a block of SM with the CMM. + * Parameters: + * hCmmMgr: Handle to a Cmm Mgr. + * lpGPPBasePA: GPP Base Physical address. + * ulSize: Size in GPP bytes. + * dwDSPAddrOffset GPP PA to DSP PA Offset. + * cFactor: Add offset if CMM_ADDTODSPPA, sub if CMM_SUBFROMDSPPA. + * dwDSPBase: DSP virtual base byte address. + * ulDSPSize: Size of DSP segment in bytes. + * pulSegId: Address to store segment Id. + * + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hCmmMgr handle. + * DSP_EINVALIDARG: Invalid input argument. + * DSP_EFAIL: Unable to register. + * - On success *pulSegId is a valid SM segment ID. + * Requires: + * ulSize > 0 + * pulSegId != NULL + * dwGPPBasePA != 0 + * cFactor = CMM_ADDTODSPPA || cFactor = CMM_SUBFROMDSPPA + * Ensures: + * + */ + extern DSP_STATUS CMM_RegisterGPPSMSeg(struct CMM_OBJECT *hCmmMgr, + unsigned int dwGPPBasePA, + u32 ulSize, + u32 dwDSPAddrOffset, + enum CMM_CNVTTYPE cFactor, + unsigned int dwDSPBase, + u32 ulDSPSize, + u32 *pulSegId, + u32 dwGPPBaseBA); + +/* + * ======== CMM_UnRegisterGPPSMSeg ======== + * Purpose: + * Unregister the given memory segment that was previously registered + * by CMM_RegisterGPPSMSeg. + * Parameters: + * hCmmMgr: Handle to a Cmm Mgr. + * ulSegId Segment identifier returned by CMM_RegisterGPPSMSeg. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid handle. + * DSP_EINVALIDARG: Invalid ulSegId. + * DSP_EFAIL: Unable to unregister for unknown reason. + * Requires: + * Ensures: + * + */ + extern DSP_STATUS CMM_UnRegisterGPPSMSeg(struct CMM_OBJECT *hCmmMgr, + u32 ulSegId); + +/* + * ======== CMM_XlatorAllocBuf ======== + * Purpose: + * Allocate the specified SM buffer and create a local memory descriptor. + * Place on the descriptor on the translator's HaQ (Host Alloc'd Queue). + * Parameters: + * hXlator: Handle to a Xlator object. + * pVaBuf: Virtual address ptr(client context) + * uPaSize: Size of SM memory to allocate. + * Returns: + * Ptr to valid physical address(Pa) of uPaSize bytes, NULL if failed. + * Requires: + * pVaBuf != 0. + * uPaSize != 0. + * Ensures: + * + */ + extern void *CMM_XlatorAllocBuf(struct CMM_XLATOROBJECT *hXlator, + void *pVaBuf, u32 uPaSize); + +/* + * ======== CMM_XlatorCreate ======== + * Purpose: + * Create a translator(xlator) object used for process specific Va<->Pa + * address translation. Node messaging and streams use this to perform + * inter-processor(GPP<->DSP) zero-copy data transfer. + * Parameters: + * phXlator: Address to place handle to a new Xlator handle. + * hCmmMgr: Handle to Cmm Mgr associated with this translator. + * pXlatorAttrs: Translator attributes used for the client NODE or STREAM. + * Returns: + * DSP_SOK: Success. + * DSP_EINVALIDARG: Bad input Attrs. + * DSP_EMEMORY: Insufficient memory(local) for requested resources. + * Requires: + * phXlator != NULL + * hCmmMgr != NULL + * pXlatorAttrs != NULL + * Ensures: + * + */ + extern DSP_STATUS CMM_XlatorCreate(OUT struct CMM_XLATOROBJECT **phXlator, + struct CMM_OBJECT *hCmmMgr, + struct CMM_XLATORATTRS *pXlatorAttrs); + +/* + * ======== CMM_XlatorDelete ======== + * Purpose: + * Delete translator resources + * Parameters: + * hXlator: handle to translator. + * bForce: bForce = TRUE will free XLators SM buffers/dscriptrs. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Bad translator handle. + * DSP_EFAIL: Unable to free translator resources. + * Requires: + * cRefs > 0 + * Ensures: + * + */ + extern DSP_STATUS CMM_XlatorDelete(struct CMM_XLATOROBJECT *hXlator, + bool bForce); + +/* + * ======== CMM_XlatorFreeBuf ======== + * Purpose: + * Free SM buffer and descriptor. + * Does not free client process VM. + * Parameters: + * hXlator: handle to translator. + * pBufVa Virtual address of PA to free. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Bad translator handle. + * Requires: + * Ensures: + * + */ + extern DSP_STATUS CMM_XlatorFreeBuf(struct CMM_XLATOROBJECT *hXlator, + void *pBufVa); + +/* + * ======== CMM_XlatorInfo ======== + * Purpose: + * Set/Get process specific "translator" address info. + * This is used to perform fast virtaul address translation + * for shared memory buffers between the GPP and DSP. + * Parameters: + * hXlator: handle to translator. + * pAddr: Virtual base address of segment. + * ulSize: Size in bytes. + * uSegId: Segment identifier of SM segment(s) + * bSetInfo Set xlator fields if TRUE, else return base addr + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Bad translator handle. + * Requires: + * (cRefs > 0) + * (pAddr != NULL) + * (ulSize > 0) + * Ensures: + * + */ + extern DSP_STATUS CMM_XlatorInfo(struct CMM_XLATOROBJECT *hXlator, + IN OUT u8 **pAddr, + u32 ulSize, u32 uSegId, + bool bSetInfo); + +/* + * ======== CMM_XlatorTranslate ======== + * Purpose: + * Perform address translation VA<->PA for the specified stream or + * message shared memory buffer. + * Parameters: + * hXlator: handle to translator. + * pAddr address of buffer to translate. + * xType Type of address xlation. CMM_PA2VA or CMM_VA2PA. + * Returns: + * Valid address on success, else NULL. + * Requires: + * cRefs > 0 + * pAddr != NULL + * xType >= CMM_VA2PA) && (xType <= CMM_DSPPA2PA) + * Ensures: + * + */ + extern void *CMM_XlatorTranslate(struct CMM_XLATOROBJECT *hXlator, + void *pAddr, enum CMM_XLATETYPE xType); + +#endif /* CMM_ */ diff --git a/arch/arm/plat-omap/include/bridge/cmmdefs.h b/arch/arm/plat-omap/include/bridge/cmmdefs.h new file mode 100644 index 0000000..680400c --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/cmmdefs.h @@ -0,0 +1,135 @@ +/* + * arch/arm/plat-omap/include/bridge/cmmdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== cmmdefs.h ======== + * Purpose: + * Global MEM constants and types. + * + *! Revision History: + *! ================ + *! 12-Nov-2001 ag CMM_KERNMAPTYPE added for dsp<->device process addr map'n. + *! This allows addr conversion from drvr process <-> DSP addr. + *! 29-Aug-2001 ag Added CMM_ALLSEGMENTS. + *! 08-Dec-2000 ag Added bus address conversion type CMM_POMAPEMIF2DSPBUS. + *! 05-Dec-2000 ag Added default CMM_DEFLTCONVFACTOR & CMM_DEFLTDSPADDROFFSET. + *! 29-Oct-2000 ag Added converstion factor for GPP DSP Pa translation. + *! 15-Oct-2000 ag Added address translator attributes and defaults. + *! 12-Jul-2000 ag Created. + */ + +#ifndef CMMDEFS_ +#define CMMDEFS_ + +#include + +/* Cmm attributes used in CMM_Create() */ + struct CMM_MGRATTRS { + /* Minimum SM allocation; default 32 bytes. */ + u32 ulMinBlockSize; + } ; + +/* Attributes for CMM_AllocBuf() & CMM_AllocDesc() */ + struct CMM_ATTRS { + u32 ulSegId; /* 1,2... are SM segments. 0 is not. */ + u32 ulAlignment; /* 0,1,2,4....ulMinBlockSize */ + } ; + +/* + * DSPPa to GPPPa Conversion Factor. + * + * For typical platforms: + * converted Address = PaDSP + ( cFactor * addressToConvert). + */ + enum CMM_CNVTTYPE { + CMM_SUBFROMDSPPA = -1, + /* PreOMAP is special case: not simple offset */ + CMM_POMAPEMIF2DSPBUS = 0, + CMM_ADDTODSPPA = 1 + } ; + +#define CMM_DEFLTDSPADDROFFSET 0 +#define CMM_DEFLTCONVFACTOR CMM_POMAPEMIF2DSPBUS /* PreOMAP DSPBUS<->EMIF */ +#define CMM_ALLSEGMENTS 0xFFFFFF /* All SegIds */ +#define CMM_MAXGPPSEGS 1 /* Maximum # of SM segs */ + +/* + * SMSEGs are SM segments the DSP allocates from. + * + * This info is used by the GPP to xlate DSP allocated PAs. + */ + + struct CMM_SEGINFO { + u32 dwSegBasePa; /* Start Phys address of SM segment */ + /* Total size in bytes of segment: DSP+GPP */ + u32 ulTotalSegSize; + u32 dwGPPBasePA; /* Start Phys addr of Gpp SM seg */ + u32 ulGPPSize; /* Size of Gpp SM seg in bytes */ + u32 dwDSPBaseVA; /* DSP virt base byte address */ + u32 ulDSPSize; /* DSP seg size in bytes */ + /* # of current GPP allocations from this segment */ + u32 ulInUseCnt; + u32 dwSegBaseVa; /* Start Virt address of SM seg */ + + } ; + +/* CMM useful information */ + struct CMM_INFO { + /* # of SM segments registered with this Cmm. */ + u32 ulNumGPPSMSegs; + /* Total # of allocations outstanding for CMM */ + u32 ulTotalInUseCnt; + /* Min SM block size allocation from CMM_Create() */ + u32 ulMinBlockSize; + /* Info per registered SM segment. */ + struct CMM_SEGINFO segInfo[CMM_MAXGPPSEGS]; + } ; + +/* XlatorCreate attributes */ + struct CMM_XLATORATTRS { + u32 ulSegId; /* segment Id used for SM allocations */ + u32 dwDSPBufs; /* # of DSP-side bufs */ + u32 dwDSPBufSize; /* size of DSP-side bufs in GPP bytes */ + /* Vm base address alloc'd in client process context */ + void *pVmBase; + /* dwVmSize must be >= (dwMaxNumBufs * dwMaxSize) */ + u32 dwVmSize; + } ; + +/* + * Cmm translation types. Use to map SM addresses to process context. + */ + enum CMM_XLATETYPE { + CMM_VA2PA = 0, /* Virtual to GPP physical address xlation */ + CMM_PA2VA = 1, /* GPP Physical to virtual */ + CMM_VA2DSPPA = 2, /* Va to DSP Pa */ + CMM_PA2DSPPA = 3, /* GPP Pa to DSP Pa */ + CMM_DSPPA2PA = 4, /* DSP Pa to GPP Pa */ + } ; + +/* + * Used to "map" between device process virt addr and dsp addr. + */ + enum CMM_KERNMAPTYPE { + CMM_KERNVA2DSP = 0, /* Device process context to dsp address. */ + CMM_DSP2KERNVA = 1, /* Dsp address to device process context. */ + } ; + + struct CMM_OBJECT; + struct CMM_XLATOROBJECT; + +#endif /* CMMDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/cod.h b/arch/arm/plat-omap/include/bridge/cod.h new file mode 100644 index 0000000..310c2a2 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/cod.h @@ -0,0 +1,494 @@ +/* + * arch/arm/plat-omap/include/bridge/cod.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== cod.h ======== + * Description: + * Code management module for DSPs. This module provides an interface + * interface for loading both static and dynamic code objects onto DSP + * systems. + * + * Public Functions: + * COD_Close + * COD_Create + * COD_Delete + * COD_Exit + * COD_GetBaseLib + * COD_GetBaseName + * COD_GetLoader + * COD_GetSection + * COD_GetSymValue + * COD_Init + * COD_LoadBase + * COD_Open + * COD_OpenBase + * COD_ReadSection + * COD_UnloadSection + * + * Note: + * Currently, only static loading is supported. + * + *! Revision History + *! ================ + *! 08-Apr-2003 map: Changed DBL to DBLL + *! 07-Aug-2002 jeh: Added COD_GetBaseName(). + *! 17-Jul-2002 jeh: Added COD_Open(), COD_Close(). + *! 15-Mar-2002 jeh: Added DBL_Flags param to COD_OpenBase(). + *! 19-Oct-2001 jeh: Added COD_GetBaseLib, COD_GetLoader, (left in + *! COD_LoadSection(), COD_UnloadSection(), since they + *! may be needed for BridgeLite). + *! 07-Sep-2001 jeh: Added COD_LoadSection(), COD_UnloadSection(). + *! 11-Jan-2001 jeh: Added COD_OpenBase. + *! 29-Sep-2000 kc: Added size param to COD_ReadSection for input buffer + *! validation. + *! 02-Aug-2000 kc: Added COD_ReadSection. + *! 04-Sep-1997 gp: Added CDECL identifier to COD_WRITEFXN (for NT).. + *! 18-Aug-1997 cr: Added explicit CDECL identifier. + *! 28-Oct-1996 gp: Added COD_GetSection. + *! 30-Jul-1996 gp: Added envp[] argument to COD_LoadBase(). + *! 12-Jun-1996 gp: Moved OUT param first in _Create(). Updated _Create() + *! call to take a ZLFileName. Moved COD_ processor types + *! to CFG. + *! 29-May-1996 gp: Changed WCD_STATUS to DSP_STATUS. Removed include's. + *! 07-May-1996 mg: Created. + * + */ + +#ifndef COD_ +#define COD_ + +#include + +#define COD_MAXPATHLENGTH 255 +#define COD_TRACEBEG "SYS_PUTCBEG" +#define COD_TRACEEND "SYS_PUTCEND" +#define COD_TRACESECT "trace" +#define COD_TRACEBEGOLD "PUTCBEG" +#define COD_TRACEENDOLD "PUTCEND" + +#define COD_NOLOAD DBLL_NOLOAD +#define COD_SYMB DBLL_SYMB + +/* Flags passed to COD_Open */ + typedef DBLL_Flags COD_FLAGS; + +/* COD code manager handle */ + struct COD_MANAGER; + +/* COD library handle */ + struct COD_LIBRARYOBJ; + +/* COD attributes */ + struct COD_ATTRS { + u32 ulReserved; + } ; + +/* + * Function prototypes for writing memory to a DSP system, allocating + * and freeing DSP memory. + */ + typedef u32(CDECL *COD_WRITEFXN) (void *pPrivRef, u32 ulDspAddr, + void *pBuf, u32 ulNumBytes, + u32 nMemSpace); + + typedef bool(CDECL *COD_ALLOCFXN) (void *pPrivRef, u32 space, + u32 ulNumBytes, u32 ulAlign, + u32 *ulDspAddr, bool fReserved); + + typedef bool(CDECL *COD_FREEFXN) (void *pPrivReg, u32 ulDspAddr, + u32 space, u32 ulNumBytes, + bool fReserved); + +/* + * ======== COD_LOADATTRS ======== + * + * Attributes that specify alloc, free, and write functions when loading + * or unloading a section. + */ + struct COD_LOADATTRS { + void *pWHandle; /* Handle to pass to write fxn */ + void *pAHandle; /* Handle to pass to alloc/free fxns */ + COD_WRITEFXN pfnWrite; + COD_ALLOCFXN pfnAlloc; + COD_FREEFXN pfnFree; + } ; + +/* + * ======== COD_Close ======== + * Purpose: + * Close a library opened with COD_Open(). + * Parameters: + * lib - Library handle returned by COD_Open(). + * Returns: + * None. + * Requires: + * COD module initialized. + * valid lib. + * Ensures: + * + */ + extern void CDECL COD_Close(struct COD_LIBRARYOBJ *lib); + +/* + * ======== COD_Create ======== + * Purpose: + * Create an object to manage code on a DSP system. This object can be + * used to load an initial program image with arguments that can later + * be expanded with dynamically loaded object files. + * Symbol table information is managed by this object and can be retrieved + * using the COD_GetSymValue() function. + * Parameters: + * phManager: created manager object + * pstrZLFile: ZL DLL filename, of length < COD_MAXPATHLENGTH. + * attrs: attributes to be used by this object. A NULL value + * will cause default attrs to be used. + * Returns: + * DSP_SOK: Success. + * COD_E_NOZLFUNCTIONS: Could not initialize ZL functions. + * COD_E_ZLCREATEFAILED: ZL_Create failed. + * DSP_ENOTIMPL: attrs was not NULL. We don't yet support + * non default values of attrs. + * Requires: + * COD module initialized. + * pstrZLFile != NULL + * Ensures: + */ + extern DSP_STATUS CDECL COD_Create(OUT struct COD_MANAGER **phManager, + char *pstrZLFile, + IN OPTIONAL CONST struct COD_ATTRS *attrs); + +/* + * ======== COD_Delete ======== + * Purpose: + * Delete a code manager object. + * Parameters: + * hManager: handle of manager to be deleted + * Returns: + * None. + * Requires: + * COD module initialized. + * valid hManager. + * Ensures: + */ + extern void CDECL COD_Delete(struct COD_MANAGER *hManager); + +/* + * ======== COD_Exit ======== + * Purpose: + * Discontinue usage of the COD module. + * Parameters: + * None. + * Returns: + * None. + * Requires: + * COD initialized. + * Ensures: + * Resources acquired in COD_Init() are freed. + */ + extern void CDECL COD_Exit(); + +/* + * ======== COD_GetBaseLib ======== + * Purpose: + * Get handle to the base image DBL library. + * Parameters: + * hManager: handle of manager to be deleted + * plib: location to store library handle on output. + * Returns: + * DSP_SOK: Success. + * Requires: + * COD module initialized. + * valid hManager. + * plib != NULL. + * Ensures: + */ + extern DSP_STATUS CDECL COD_GetBaseLib(struct COD_MANAGER *hManager, + struct DBLL_LibraryObj **plib); + +/* + * ======== COD_GetBaseName ======== + * Purpose: + * Get the name of the base image DBL library. + * Parameters: + * hManager: handle of manager to be deleted + * pszName: location to store library name on output. + * uSize: size of name buffer. + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Buffer too small. + * Requires: + * COD module initialized. + * valid hManager. + * pszName != NULL. + * Ensures: + */ + extern DSP_STATUS CDECL COD_GetBaseName(struct COD_MANAGER *hManager, + char *pszName, u32 uSize); + +/* + * ======== COD_GetEntry ======== + * Purpose: + * Retrieve the entry point of a loaded DSP program image + * Parameters: + * hManager: handle of manager to be deleted + * pulEntry: pointer to location for entry point + * Returns: + * DSP_SOK: Success. + * Requires: + * COD module initialized. + * valid hManager. + * pulEntry != NULL. + * Ensures: + */ + extern DSP_STATUS CDECL COD_GetEntry(struct COD_MANAGER *hManager, + u32 *pulEntry); + +/* + * ======== COD_GetLoader ======== + * Purpose: + * Get handle to the DBL loader. + * Parameters: + * hManager: handle of manager to be deleted + * phLoader: location to store loader handle on output. + * Returns: + * DSP_SOK: Success. + * Requires: + * COD module initialized. + * valid hManager. + * phLoader != NULL. + * Ensures: + */ + extern DSP_STATUS CDECL COD_GetLoader(struct COD_MANAGER *hManager, + struct DBLL_TarObj **phLoader); + +/* + * ======== COD_GetSection ======== + * Purpose: + * Retrieve the starting address and length of a section in the COFF file + * given the section name. + * Parameters: + * lib Library handle returned from COD_Open(). + * pstrSect: name of the section, with or without leading "." + * puAddr: Location to store address. + * puLen: Location to store length. + * Returns: + * DSP_SOK: Success + * COD_E_NOSYMBOLSLOADED: Symbols have not been loaded onto the board. + * COD_E_SYMBOLNOTFOUND: The symbol could not be found. + * Requires: + * COD module initialized. + * valid hManager. + * pstrSect != NULL; + * puAddr != NULL; + * puLen != NULL; + * Ensures: + * DSP_SOK: *puAddr and *puLen contain the address and length of the + * section. + * else: *puAddr == 0 and *puLen == 0; + * + */ + extern DSP_STATUS CDECL COD_GetSection(struct COD_LIBRARYOBJ *lib, + IN char *pstrSect, + OUT u32 *puAddr, + OUT u32 *puLen); + +/* + * ======== COD_GetSymValue ======== + * Purpose: + * Retrieve the value for the specified symbol. The symbol is first + * searched for literally and then, if not found, searched for as a + * C symbol. + * Parameters: + * lib: library handle returned from COD_Open(). + * pstrSymbol: name of the symbol + * value: value of the symbol + * Returns: + * DSP_SOK: Success. + * COD_E_NOSYMBOLSLOADED: Symbols have not been loaded onto the board. + * COD_E_SYMBOLNOTFOUND: The symbol could not be found. + * Requires: + * COD module initialized. + * Valid hManager. + * pstrSym != NULL. + * pulValue != NULL. + * Ensures: + */ + extern DSP_STATUS CDECL COD_GetSymValue(struct COD_MANAGER *hManager, + IN char *pstrSym, + OUT u32 *pulValue); + +/* + * ======== COD_Init ======== + * Purpose: + * Initialize the COD module's private state. + * Parameters: + * None. + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * A requirement for each of the other public COD functions. + */ + extern bool CDECL COD_Init(); + +/* + * ======== COD_LoadBase ======== + * Purpose: + * Load the initial program image, optionally with command-line arguments, + * on the DSP system managed by the supplied handle. The program to be + * loaded must be the first element of the args array and must be a fully + * qualified pathname. + * Parameters: + * hMgr: manager to load the code with + * nArgc: number of arguments in the args array + * args: array of strings for arguments to DSP program + * writeFxn: board-specific function to write data to DSP system + * pArb: arbitrary pointer to be passed as first arg to writeFxn + * envp: array of environment strings for DSP exec. + * Returns: + * DSP_SOK: Success. + * COD_E_OPENFAILED: Failed to open target code. + * COD_E_LOADFAILED: Failed to load code onto target. + * Requires: + * COD module initialized. + * hMgr is valid. + * nArgc > 0. + * aArgs != NULL. + * aArgs[0] != NULL. + * pfnWrite != NULL. + * Ensures: + */ + extern DSP_STATUS CDECL COD_LoadBase(struct COD_MANAGER *hManager, + u32 nArgc, char *aArgs[], + COD_WRITEFXN pfnWrite, void *pArb, + char *envp[]); + +/* + * ======== COD_LoadSection ======== + * Purpose: + * Load a named section in the COFF file. (For overlay support). + * Parameters: + * hManager: COD manager. + * pstrSect: Name of the section, with or without leading "." + * pAttrs: Specifies alloc, free, and write function. + * Returns: + * DSP_SOK: Success + * DSP_EFWRITE: Failed to write section to target. + * Requires: + * COD module initialized. + * valid hManager. + * pstrSect != NULL; + * Ensures: + * + */ + extern DSP_STATUS CDECL COD_LoadSection(struct COD_MANAGER *hManager, + IN char *pstrSect, + IN struct COD_LOADATTRS *pAttrs); + +/* + * ======== COD_Open ======== + * Purpose: + * Open a library for reading sections. Does not load or set the base. + * Parameters: + * hMgr: manager to load the code with + * pszCoffPath: Coff file to open. + * flags: COD_NOLOAD (don't load symbols) or COD_SYMB (load + * symbols). + * pLib: Handle returned that can be used in calls to COD_Close + * and COD_GetSection. + * Returns: + * S_OK: Success. + * COD_E_OPENFAILED: Failed to open target code. + * Requires: + * COD module initialized. + * hMgr is valid. + * flags == COD_NOLOAD || flags == COD_SYMB. + * pszCoffPath != NULL. + * Ensures: + */ + extern DSP_STATUS COD_Open(struct COD_MANAGER *hMgr, + IN char *pszCoffPath, + COD_FLAGS flags, + OUT struct COD_LIBRARYOBJ **pLib); + +/* + * ======== COD_OpenBase ======== + * Purpose: + * Open base image for reading sections. Does not load the base. + * Parameters: + * hMgr: manager to load the code with + * pszCoffPath: Coff file to open. + * flags: Specifies whether to load symbols. + * Returns: + * DSP_SOK: Success. + * COD_E_OPENFAILED: Failed to open target code. + * Requires: + * COD module initialized. + * hMgr is valid. + * pszCoffPath != NULL. + * Ensures: + */ +extern DSP_STATUS COD_OpenBase(struct COD_MANAGER *hMgr, IN char *pszCoffPath, + DBLL_Flags flags); + +/* + * ======== COD_ReadSection ======== + * Purpose: + * Retrieve the content of a code section given the section name. + * Parameters: + * hManager - manager in which to search for the symbol + * pstrSect - name of the section, with or without leading "." + * pstrContent - buffer to store content of the section. + * Returns: + * DSP_SOK: on success, error code on failure + * COD_E_NOSYMBOLSLOADED: Symbols have not been loaded onto the board. + * COD_E_READFAILED: Failed to read content of code section. + * Requires: + * COD module initialized. + * valid hManager. + * pstrSect != NULL; + * pstrContent != NULL; + * Ensures: + * DSP_SOK: *pstrContent stores the content of the named section. + */ + extern DSP_STATUS CDECL COD_ReadSection(struct COD_LIBRARYOBJ *lib, + IN char *pstrSect, + OUT char *pstrContent, + IN u32 cContentSize); + +/* + * ======== COD_UnloadSection ======== + * Purpose: + * Unload a named section in the COFF file. (For overlay support). + * Parameters: + * hManager: COD manager. + * pstrSect: name of the section, with or without leading "." + * pAttrs: Specifies free function. + * Returns: + * DSP_SOK: Success. + * Requires: + * COD module initialized. + * valid hManager. + * pstrSect != NULL; + * Ensures: + * + */ + extern DSP_STATUS CDECL COD_UnloadSection(struct COD_MANAGER *hManager, + IN char *pstrSect, + IN struct COD_LOADATTRS *pAttrs); + +#endif /* COD_ */ diff --git a/arch/arm/plat-omap/include/bridge/csl.h b/arch/arm/plat-omap/include/bridge/csl.h new file mode 100644 index 0000000..f62eda1 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/csl.h @@ -0,0 +1,269 @@ +/* + * arch/arm/plat-omap/include/bridge/csl.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== csl.h ======== + * Purpose: + * Platform independent C Standard library functions. + * + * Public Functions: + * CSL_AnsiToWchar + * CSL_Atoi + * CSL_ByteSwap + * CSL_Exit + * CSL_Init + * CSL_NumToAscii + * CSL_Strcmp + * CSL_Strcpyn + * CSL_Strlen + * CSL_Strncat + * CSL_Strncmp + * CSL_Strtok + * CSL_Strtokr + * CSL_WcharToAnsi + * CSL_Wstrlen + * + *! Revision History: + *! ================ + *! 07-Aug-2002 jeh: Added CSL_Strtokr(). + *! 21-Sep-2001 jeh: Added CSL_Strncmp. + *! 22-Nov-2000 map: Added CSL_Atoi and CSL_Strtok + *! 19-Nov-2000 kc: Added CSL_ByteSwap(). + *! 09-Nov-2000 kc: Added CSL_Strncat. + *! 29-Oct-1999 kc: Added CSL_Wstrlen(). + *! 20-Sep-1999 ag: Added CSL_Wchar2Ansi(). + *! 19-Jan-1998 cr: Code review cleanup (mostly documentation fixes). + *! 29-Dec-1997 cr: Changed CSL_lowercase to CSL_Uppercase, added + *! CSL_AnsiToWchar. + *! 30-Sep-1997 cr: Added explicit cdecl descriptors to fxn definitions. + *! 25-Jun-1997 cr: Added CSL_strcmp. + *! 12-Jun-1996 gp: Created. + */ + +#ifndef CSL_ +#define CSL_ + +#include +/* + * ======== CSL_Atoi ======== + * Purpose: + * Convert a 1 or 2 digit string number into an integer + * Parameters: + * ptstrSrc: pointer to string. + * Returns: + * Integer + * Requires: + * CSL initialized. + * ptstrSrc is a valid string pointer. + * Ensures: + */ + extern s32 CSL_Atoi(IN CONST char *ptstrSrc); + +/* + * ======== CSL_Exit ======== + * Purpose: + * Discontinue usage of the CSL module. + * Parameters: + * Returns: + * Requires: + * CSL initialized. + * Ensures: + * Resources acquired in CSL_Init() are freed. + */ + extern void CSL_Exit(); + +/* + * ======== CSL_Init ======== + * Purpose: + * Initialize the CSL module's private state. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * A requirement for each of the other public CSL functions. + */ + extern bool CSL_Init(); + +/* + * ======== CSL_NumToAscii ======== + * Purpose: + * Convert a 1 or 2 digit number to a 2 digit string. + * Parameters: + * pstrNumber: Buffer to store converted string. + * dwNum: Number to convert. + * Returns: + * Requires: + * pstrNumber must be able to hold at least three characters. + * Ensures: + * pstrNumber will be null terminated. + */ + extern void CSL_NumToAscii(OUT char *pstrNumber, IN u32 dwNum); + +/* + * ======== CSL_Strcmp ======== + * Purpose: + * Compare 2 ASCII strings. Works the same way as stdio's strcmp. + * Parameters: + * pstrStr1: char * 1. + * pstrStr2: char * 2. + * Returns: + * A signed value that gives the results of the comparison: + * Zero: String1 equals String2. + * < Zero: String1 is less than String2. + * > Zero: String1 is greater than String2. + * Requires: + * CSL initialized. + * pstrStr1 is valid. + * pstrStr2 is valid. + * Ensures: + */ + extern s32 CSL_Strcmp(IN CONST char *pstrStr1, IN CONST char *pstrStr2); + +/* + * ======== CSL_Strcpyn ======== + * Purpose: + * Safe strcpy function. + * Parameters: + * pstrDest: Ptr to destination buffer. + * pstrSrc: Ptr to source buffer. + * cMax: Size of destination buffer. + * Returns: + * Ptr to destination buffer; or NULL if error. + * Requires: + * CSL initialized. + * pstrDest is valid. + * pstrSrc is valid. + * Ensures: + * Will not copy more than cMax bytes from pstrSrc into pstrDest. + * pstrDest will be terminated by a NULL character. + */ + extern char *CSL_Strcpyn(OUT char *pstrDest, IN CONST char *pstrSrc, + IN u32 cMax); + +/* + * ======== CSL_Strstr ======== + * Purpose: + * Find substring in a stringn. + * Parameters: + * haystack: Ptr to string1. + * needle: Ptr to substring to catch. + * Returns: + * Ptr to first char matching the substring in the main string. + * Requires: + * CSL initialized. + * haystack is valid. + * needle is valid. + * Ensures: + */ + extern char *CSL_Strstr(IN CONST char *haystack, IN CONST char *needle); + +/* + * ======== CSL_Strlen ======== + * Purpose: + * Determine the length of a null terminated ASCI string. + * Parameters: + * pstrSrc: pointer to string. + * Returns: + * String length in bytes. + * Requires: + * CSL initialized. + * pstrSrc is a valid string pointer. + * Ensures: + */ + extern u32 CSL_Strlen(IN CONST char *pstrSrc); + +/* + * ======== CSL_Strncat ======== + * Purpose: + * Concatenate two strings together. + * Parameters: + * pszDest: Destination string. + * pszSrc: Source string. + * dwSize: Number of characters to copy. + * Returns: + * Pointer to destination string. + * Requires: + * CSL initialized. + * pszDest and pszSrc are valid pointers. + * Ensures: + */ + extern char *CSL_Strncat(IN char *pszDest, + IN char *pszSrc, IN u32 dwSize); + +/* + * ======== CSL_Strncmp ======== + * Purpose: + * Compare at most n characters of two ASCII strings. Works the same + * way as stdio's strncmp. + * Parameters: + * pstrStr1: char * 1. + * pstrStr2: char * 2. + * n: Number of characters to compare. + * Returns: + * A signed value that gives the results of the comparison: + * Zero: String1 equals String2. + * < Zero: String1 is less than String2. + * > Zero: String1 is greater than String2. + * Requires: + * CSL initialized. + * pstrStr1 is valid. + * pstrStr2 is valid. + * Ensures: + */ + extern s32 CSL_Strncmp(IN CONST char *pstrStr1, + IN CONST char *pstrStr2, IN u32 n); + +/* + * ======== CSL_Strtok ======== + * Purpose: + * Tokenize a NULL terminated string + * Parameters: + * ptstrSrc: pointer to string. + * szSeparators: pointer to a string of seperators + * Returns: + * char * + * Requires: + * CSL initialized. + * ptstrSrc is a valid string pointer. + * szSeparators is a valid string pointer. + * Ensures: + */ + extern char *CSL_Strtok(IN char *ptstrSrc, + IN CONST char *szSeparators); + +/* + * ======== CSL_Strtokr ======== + * Purpose: + * Re-entrant version of strtok. + * Parameters: + * pstrSrc: Pointer to string. May be NULL on subsequent calls. + * szSeparators: Pointer to a string of seperators + * ppstrCur: Location to store start of string for next call to + * to CSL_Strtokr. + * Returns: + * char * (the token) + * Requires: + * CSL initialized. + * szSeparators != NULL + * ppstrCur != NULL + * Ensures: + */ + extern char *CSL_Strtokr(IN char *pstrSrc, + IN CONST char *szSeparators, + OUT char **ppstrCur); + +#endif /* CSL_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbapi.h b/arch/arm/plat-omap/include/bridge/dbapi.h new file mode 100644 index 0000000..a942848 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbapi.h @@ -0,0 +1,48 @@ +/* + * arch/arm/plat-omap/include/bridge/dbapi.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== dbapi.h ======== + * Description: + * Top level header file for GPP side DSP/BIOS Bridge APIs. + * + *! Revision History: + *! ================ + *! 22-Nov-2002 gp Cleaned up comments, formatting. + *! 13-Feb-2001 kc: Name changed from ddspapi.h to dbapi.h. + *! 27-Jun-2000 rr: Name changed to ddspapi.h. Broken into various h files. + *! 12-May-2000 gp: Removed PROC_UNKNOWN state. Moved OEM DSPProcessor_ fxns + *! to ddspoem.h. Changed DDSP_MSG to be fixed length; + *! Changed DDSPStream_Issue/Reclaim to take u32 dwArg. + *! 11-May-2000 gp: Reformatted; converted tabs to spaces; changed NODEHANDLE + *! to HNODE; changed GUID to UUID; added "Detail" sections + *! documenting differences from DDSP API spec. (ver. 0.6); + *! enhanced comments. + *! 19-Apr-2000 ww: Updated based on code review. + *! 12-Apr-2000 ww: Created based on DSP/BIOS Bridge API specification, Ver 0.6. + */ + +#ifndef DBAPI_ +#define DBAPI_ + +#include /* DSP/BIOS Bridge global definitions and constants */ +#include /* DSP/BIOS Bridge status and error codes */ +#include /* DSP/BIOS Bridge Manager APIs */ +#include /* DSP/BIOS Bridge Processor APIs */ +#include /* DSP/BIOS Bridge Node APIs */ +#include /* DSP/BIOS Bridge Stream APIs */ + +#endif /* DBAPI_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbc.h b/arch/arm/plat-omap/include/bridge/dbc.h new file mode 100644 index 0000000..bff5cb5 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbc.h @@ -0,0 +1,66 @@ +/* + * arch/arm/plat-omap/include/bridge/dbc.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== dbc.h ======== + * Purpose: + * "Design by Contract" programming macros. + * + * Public Functions: + * DBC_Assert + * DBC_Require + * DBC_Ensure + * + * Notes: + * Requires that the GT->ERROR function has been defaulted to a valid + * error handler for the given execution environment. + * + * Does not require that GT_init() be called. + * + *! Revision History: + *! ================ + *! 11-Aug-2000 ag: Removed include + *! 22-Apr-1996 gp: Created. + */ + +#ifndef DBC_ +#define DBC_ + +#ifndef GT_TRACE +#define GT_TRACE 0 /* 0 = "trace compiled out"; 1 = "trace active" */ +#endif + +/* Assertion Macros: */ +#if GT_TRACE + +#include + +#define DBC_Assert(exp) \ + if (!(exp)) \ + (*GT->ERRORFXN)("%s, line %d: Assertion (" #exp ") failed.\n", \ + __FILE__, __LINE__) +#define DBC_Require DBC_Assert /* Function Precondition. */ +#define DBC_Ensure DBC_Assert /* Function Postcondition. */ + +#else + +#define DBC_Assert(exp) +#define DBC_Require(exp) +#define DBC_Ensure(exp) + +#endif /* DEBUG */ + +#endif /* DBC_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbdcd.h b/arch/arm/plat-omap/include/bridge/dbdcd.h new file mode 100644 index 0000000..1ec41f3 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbdcd.h @@ -0,0 +1,388 @@ +/* + * arch/arm/plat-omap/include/bridge/dbdcd.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== dbdcd.h ======== + * Description: + * Defines the DSP/BIOS Bridge Configuration Database (DCD) API. + * + *! Revision History + *! ================ + *! 03-Dec-2003 map Changed DCD_OBJTYPE to DSP_DCDOBJTYPE + *! 24-Feb-2003 kc Updated DCD_AutoUnregister and DCD_GetObjects to simplify + *! DCD implementation. + *! 05-Aug-2002 jeh Added DCD_GetObjects(). + *! 11-Jul-2002 jeh Added DCD_GetDepLibs(), DCD_GetNumDepLibs(). + *! 22-Apr-2002 jeh Added DCD_GetLibraryName(). + *! 03-Apr-2001 sg Changed error names to have DCD_E* format. + *! 13-Feb-2001 kc Name changed from dcdbs.h to dbdcd.h. + *! 12-Dec-2000 kc Added DCD_AutoUnregister. + *! 09-Nov-2000 kc Updated usage of DCD_EnumerateObject. + *! 30-Oct-2000 kc Added DCD_AutoRegister. Updated error DCD error codes. + *! 29-Sep-2000 kc Incorporated code review comments. See + *! /src/reviews/dcd_review.txt. + *! 26-Jul-2000 kc Created. + *! + */ + +#ifndef DBDCD_ +#define DBDCD_ + +#include +#include +#include + +/* + * ======== DCD_AutoRegister ======== + * Purpose: + * This function automatically registers DCD objects specified in a + * special COFF section called ".dcd_register" + * Parameters: + * hDcdMgr: A DCD manager handle. + * pszCoffPath: Pointer to name of COFF file containing DCD + * objects to be registered. + * Returns: + * DSP_SOK: Success. + * DSP_EDCDNOAUTOREGISTER: Unable to find auto-registration section. + * DSP_EDCDREADSECT: Unable to read object code section. + * DSP_EDCDLOADBASE: Unable to load code base. + * DSP_EHANDLE: Invalid DCD_HMANAGER handle.. + * Requires: + * DCD initialized. + * Ensures: + * Note: + * Due to the DCD database construction, it is essential for a DCD-enabled + * COFF file to contain the right COFF sections, especially + * ".dcd_register", which is used for auto registration. + */ + extern DSP_STATUS DCD_AutoRegister(IN struct DCD_MANAGER *hDcdMgr, + IN char *pszCoffPath); + +/* + * ======== DCD_AutoUnregister ======== + * Purpose: + * This function automatically unregisters DCD objects specified in a + * special COFF section called ".dcd_register" + * Parameters: + * hDcdMgr: A DCD manager handle. + * pszCoffPath: Pointer to name of COFF file containing + * DCD objects to be unregistered. + * Returns: + * DSP_SOK: Success. + * DSP_EDCDNOAUTOREGISTER: Unable to find auto-registration section. + * DSP_EDCDREADSECT: Unable to read object code section. + * DSP_EDCDLOADBASE: Unable to load code base. + * DSP_EHANDLE: Invalid DCD_HMANAGER handle.. + * Requires: + * DCD initialized. + * Ensures: + * Note: + * Due to the DCD database construction, it is essential for a DCD-enabled + * COFF file to contain the right COFF sections, especially + * ".dcd_register", which is used for auto unregistration. + */ + extern DSP_STATUS DCD_AutoUnregister(IN struct DCD_MANAGER *hDcdMgr, + IN char *pszCoffPath); + +/* + * ======== DCD_CreateManager ======== + * Purpose: + * This function creates a DCD module manager. + * Parameters: + * pszZlDllName: Pointer to a DLL name string. + * phDcdMgr: A pointer to a DCD manager handle. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Unable to allocate memory for DCD manager handle. + * DSP_EFAIL: General failure. + * Requires: + * DCD initialized. + * pszZlDllName is non-NULL. + * phDcdMgr is non-NULL. + * Ensures: + * A DCD manager handle is created. + */ + extern DSP_STATUS DCD_CreateManager(IN char *pszZlDllName, + OUT struct DCD_MANAGER **phDcdMgr); + +/* + * ======== DCD_DestroyManager ======== + * Purpose: + * This function destroys a DCD module manager. + * Parameters: + * hDcdMgr: A DCD manager handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid DCD manager handle. + * Requires: + * DCD initialized. + * Ensures: + */ + extern DSP_STATUS DCD_DestroyManager(IN struct DCD_MANAGER *hDcdMgr); + +/* + * ======== DCD_EnumerateObject ======== + * Purpose: + * This function enumerates currently visible DSP/BIOS Bridge objects + * and returns the UUID and type of each enumerated object. + * Parameters: + * cIndex: The object enumeration index. + * objType: Type of object to enumerate. + * pUuid: Pointer to a DSP_UUID object. + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Unable to enumerate through the DCD database. + * DSP_SENUMCOMPLETE: Enumeration completed. This is not an error code. + * Requires: + * DCD initialized. + * pUuid is a valid pointer. + * Ensures: + * Details: + * This function can be used in conjunction with DCD_GetObjectDef to + * retrieve object properties. + */ + extern DSP_STATUS DCD_EnumerateObject(IN s32 cIndex, + IN enum DSP_DCDOBJTYPE objType, + OUT struct DSP_UUID *pUuid); + +/* + * ======== DCD_Exit ======== + * Purpose: + * This function cleans up the DCD module. + * Parameters: + * Returns: + * Requires: + * DCD initialized. + * Ensures: + */ + extern void DCD_Exit(); + +/* + * ======== DCD_GetDepLibs ======== + * Purpose: + * Given the uuid of a library and size of array of uuids, this function + * fills the array with the uuids of all dependent libraries of the input + * library. + * Parameters: + * hDcdMgr: A DCD manager handle. + * pUuid: Pointer to a DSP_UUID for a library. + * numLibs: Size of uuid array (number of library uuids). + * pDepLibUuids: Array of dependent library uuids to be filled in. + * pPersistentDepLibs: Array indicating if corresponding lib is persistent. + * phase: phase to obtain correct input library + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failure. + * DSP_EDCDREADSECT: Failure to read section containing library info. + * DSP_EFAIL: General failure. + * Requires: + * DCD initialized. + * Valid hDcdMgr. + * pUuid != NULL + * pDepLibUuids != NULL. + * Ensures: + */ + extern DSP_STATUS DCD_GetDepLibs(IN struct DCD_MANAGER *hDcdMgr, + IN struct DSP_UUID *pUuid, + u16 numLibs, + OUT struct DSP_UUID *pDepLibUuids, + OUT bool *pPersistentDepLibs, + IN enum NLDR_PHASE phase); + +/* + * ======== DCD_GetNumDepLibs ======== + * Purpose: + * Given the uuid of a library, determine its number of dependent + * libraries. + * Parameters: + * hDcdMgr: A DCD manager handle. + * pUuid: Pointer to a DSP_UUID for a library. + * pNumLibs: Size of uuid array (number of library uuids). + * pNumPersLibs: number of persistent dependent library. + * phase: Phase to obtain correct input library + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failure. + * DSP_EDCDREADSECT: Failure to read section containing library info. + * DSP_EFAIL: General failure. + * Requires: + * DCD initialized. + * Valid hDcdMgr. + * pUuid != NULL + * pNumLibs != NULL. + * Ensures: + */ + extern DSP_STATUS DCD_GetNumDepLibs(IN struct DCD_MANAGER *hDcdMgr, + IN struct DSP_UUID *pUuid, + OUT u16 *pNumLibs, + OUT u16 *pNumPersLibs, + IN enum NLDR_PHASE phase); + +/* + * ======== DCD_GetLibraryName ======== + * Purpose: + * This function returns the name of a (dynamic) library for a given + * UUID. + * Parameters: + * hDcdMgr: A DCD manager handle. + * pUuid: Pointer to a DSP_UUID that represents a unique DSP/BIOS + * Bridge object. + * pstrLibName: Buffer to hold library name. + * pdwSize: Contains buffer size. Set to string size on output. + * phase: Which phase to load + * fPhaseSplit: Are phases in multiple libraries + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: General failure. + * Requires: + * DCD initialized. + * Valid hDcdMgr. + * pstrLibName != NULL. + * pUuid != NULL + * pdwSize != NULL. + * Ensures: + */ + extern DSP_STATUS DCD_GetLibraryName(IN struct DCD_MANAGER *hDcdMgr, + IN struct DSP_UUID *pUuid, + IN OUT char *pstrLibName, + IN OUT u32 *pdwSize, + IN enum NLDR_PHASE phase, + OUT bool *fPhaseSplit); + +/* + * ======== DCD_GetObjectDef ======== + * Purpose: + * This function returns the properties/attributes of a DSP/BIOS Bridge + * object. + * Parameters: + * hDcdMgr: A DCD manager handle. + * pUuid: Pointer to a DSP_UUID that represents a unique + * DSP/BIOS Bridge object. + * objType: The type of DSP/BIOS Bridge object to be + * referenced (node, processor, etc). + * pObjDef: Pointer to an object definition structure. A + * union of various possible DCD object types. + * Returns: + * DSP_SOK: Success. + * DSP_EDCDPARSESECT: Unable to parse content of object code section. + * DSP_EDCDREADSECT: Unable to read object code section. + * DSP_EDCDGETSECT: Unable to access object code section. + * DSP_EDCDLOADBASE: Unable to load code base. + * DSP_EFAIL: General failure. + * DSP_EHANDLE: Invalid DCD_HMANAGER handle. + * Requires: + * DCD initialized. + * pObjUuid is non-NULL. + * pObjDef is non-NULL. + * Ensures: + */ + extern DSP_STATUS DCD_GetObjectDef(IN struct DCD_MANAGER *hDcdMgr, + IN struct DSP_UUID *pObjUuid, + IN enum DSP_DCDOBJTYPE objType, + OUT struct DCD_GENERICOBJ *pObjDef); + +/* + * ======== DCD_GetObjects ======== + * Purpose: + * This function finds all DCD objects specified in a special + * COFF section called ".dcd_register", and for each object, + * call a "register" function. The "register" function may perform + * various actions, such as 1) register nodes in the node database, 2) + * unregister nodes from the node database, and 3) add overlay nodes. + * Parameters: + * hDcdMgr: A DCD manager handle. + * pszCoffPath: Pointer to name of COFF file containing DCD + * objects. + * registerFxn: Callback fxn to be applied on each located + * DCD object. + * handle: Handle to pass to callback. + * Returns: + * DSP_SOK: Success. + * DSP_EDCDNOAUTOREGISTER: Unable to find .dcd_register section. + * DSP_EDCDREADSECT: Unable to read object code section. + * DSP_EDCDLOADBASE: Unable to load code base. + * DSP_EHANDLE: Invalid DCD_HMANAGER handle.. + * Requires: + * DCD initialized. + * Ensures: + * Note: + * Due to the DCD database construction, it is essential for a DCD-enabled + * COFF file to contain the right COFF sections, especially + * ".dcd_register", which is used for auto registration. + */ + extern DSP_STATUS DCD_GetObjects(IN struct DCD_MANAGER *hDcdMgr, + IN char *pszCoffPath, + DCD_REGISTERFXN registerFxn, + void *handle); + +/* + * ======== DCD_Init ======== + * Purpose: + * This function initializes DCD. + * Parameters: + * Returns: + * FALSE: Initialization failed. + * TRUE: Initialization succeeded. + * Requires: + * Ensures: + * DCD initialized. + */ + extern bool DCD_Init(); + +/* + * ======== DCD_RegisterObject ======== + * Purpose: + * This function registers a DSP/BIOS Bridge object in the DCD database. + * Parameters: + * pUuid: Pointer to a DSP_UUID that identifies a DSP/BIOS + * Bridge object. + * objType: Type of object. + * pszPathName: Path to the object's COFF file. + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Failed to register object. + * Requires: + * DCD initialized. + * pUuid and szPathName are non-NULL values. + * objType is a valid type value. + * Ensures: + */ + extern DSP_STATUS DCD_RegisterObject(IN struct DSP_UUID *pUuid, + IN enum DSP_DCDOBJTYPE objType, + IN char *pszPathName); + +/* + * ======== DCD_UnregisterObject ======== + * Purpose: + * This function de-registers a valid DSP/BIOS Bridge object from the DCD + * database. + * Parameters: + * pUuid: Pointer to a DSP_UUID that identifies a DSP/BIOS Bridge + * object. + * objType: Type of object. + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Unable to de-register the specified object. + * Requires: + * DCD initialized. + * pUuid is a non-NULL value. + * objType is a valid type value. + * Ensures: + */ + extern DSP_STATUS DCD_UnregisterObject(IN struct DSP_UUID *pUuid, + IN enum DSP_DCDOBJTYPE objType); + +#endif /* _DBDCD_H */ diff --git a/arch/arm/plat-omap/include/bridge/dbdcddef.h b/arch/arm/plat-omap/include/bridge/dbdcddef.h new file mode 100644 index 0000000..9cb559b --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbdcddef.h @@ -0,0 +1,94 @@ +/* + * arch/arm/plat-omap/include/bridge/dbdcddef.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dbdcddef.h ======== + * Description: + * DCD (DSP/BIOS Bridge Configuration Database) constants and types. + * + *! Revision History: + *! ================ + *! 03-Dec-2003 map Moved and renamed DCD_OBJTYPE to DSP_DCDOBJTYPE in dbdefs.h + *! 05-Dec-2002 map Added DCD_CREATELIBTYPE, DCD_EXECUTELIBTYPE, + * DCD_DELETELIBTYPE + *! 24-Feb-2003 kc Updated REG entry names to DspBridge. + *! 22-Nov-2002 gp Cleaned up comments, formatting. + *! 05-Aug-2002 jeh Added DCD_REGISTERFXN. + *! 19-Apr-2002 jeh Added DCD_LIBRARYTYPE to DCD_OBJTYPE, dynamic load + *! properties to DCD_NODEPROPS. + *! 29-Jul-2001 ag Added extended procObj. + *! 13-Feb-2001 kc: Named changed from dcdbsdef.h dbdcddef.h. + *! 12-Dec-2000 jeh Added DAIS iAlg name to DCD_NODEPROPS. + *! 30-Oct-2000 kc: Added #defines for DCD_AutoRegister function. + *! 05-Sep-2000 jeh Added DCD_NODEPROPS. + *! 12-Aug-2000 kc: Incoroporated the use of types defined in . + *! 29-Jul-2000 kc: Created. + */ + +#ifndef DBDCDDEF_ +#define DBDCDDEF_ + +#include +#include /* for MGR_PROCESSOREXTINFO */ + +/* + * The following defines are critical elements for the DCD module: + * + * - DCD_REGKEY enables DCD functions to locate registered DCD objects. + * - DCD_REGISTER_SECTION identifies the COFF section where the UUID of + * registered DCD objects are stored. + */ +#define DCD_REGKEY "Software\\TexasInstruments\\DspBridge\\DCD" +#define DCD_REGISTER_SECTION ".dcd_register" + +/* DCD Manager Object */ + struct DCD_MANAGER; + +/* DCD Node Properties */ + struct DCD_NODEPROPS { + struct DSP_NDBPROPS ndbProps; + u32 uMsgSegid; + u32 uMsgNotifyType; + char *pstrCreatePhaseFxn; + char *pstrDeletePhaseFxn; + char *pstrExecutePhaseFxn; + char *pstrIAlgName; + + /* Dynamic load properties */ + u16 usLoadType; /* Static, dynamic, overlay */ + u32 ulDataMemSegMask; /* Data memory requirements */ + u32 ulCodeMemSegMask; /* Code memory requirements */ + } ; + +/* DCD Generic Object Type */ + struct DCD_GENERICOBJ { + union dcdObjUnion { + struct DCD_NODEPROPS nodeObj; /* node object. */ + /* processor object. */ + struct DSP_PROCESSORINFO procObj; + /* extended proc object (private) */ + struct MGR_PROCESSOREXTINFO extProcObj; + } objData; + } ; + +/* DCD Internal Callback Type */ + typedef DSP_STATUS(CDECL *DCD_REGISTERFXN) (IN struct DSP_UUID *pUuid, + IN enum DSP_DCDOBJTYPE objType, + IN void *handle); + +#endif /* DBDCDDEF_ */ + diff --git a/arch/arm/plat-omap/include/bridge/dbdefs.h b/arch/arm/plat-omap/include/bridge/dbdefs.h new file mode 100644 index 0000000..d679250 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbdefs.h @@ -0,0 +1,564 @@ +/* + * arch/arm/plat-omap/include/bridge/dbdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== dbdefs.h ======== + * Description: + * Global definitions and constants for DSP/BIOS Bridge. + * + *! Revision History: + *! ================ + *! 19-Apr-2004 sb Aligned DMM definitions with Symbian + *! 08-Mar-2004 sb Added MAPATTR & ELEM_SIZE for Dynamic Memory Mapping feature + *! 09-Feb-2004 vp Added processor ID numbers for DSP and IVA + *! 06-Feb-2003 kc Removed DSP_POSTMESSAGE. Updated IsValid*Event macros. + *! 22-Nov-2002 gp Cleaned up comments, formatting. + *! Removed unused DSP_ENUMLASTNODE define. + *! 13-Feb-2002 jeh Added uSysStackSize to DSP_NDBPROPS. + *! 23-Jan-2002 ag Added #define DSP_SHMSEG0. + *! 12-Dec-2001 ag Added DSP_ESTRMMODE error code. + *! 04-Dec-2001 jeh Added DSP_ENOTCONNECTED error code. + *! 10-Dec-2001 kc: Modified macros and definitions to disable DSP_POSTMESSAGE. + *! 01-Nov-2001 jeh Added DSP_EOVERLAYMEMORY. + *! 18-Oct-2001 ag Added DSP_STRMMODE type. + *! Added DSP_ENOTSHAREDMEM. + *! 21-Sep-2001 ag Added additional error codes. + *! 07-Jun-2001 sg Made DSPStream_AllocateBuffer fxn name plural. + *! 11-May-2001 jeh Changed DSP_NODE_MIN_PRIORITY from 0 to 1. Removed hNode + *! from DSP_NODEINFO. + *! 02-Apr-2001 sg Added missing error codes, rearranged codes, switched to + *! hex offsets, renamed some codes to match API spec. + *! 16-Jan-2001 jeh Added DSP_ESYMBOL, DSP_EUUID. + *! 13-Feb-2001 kc: DSP/BIOS Bridge name updates. + *! 05-Dec-2000 ag: Added DSP_RMSxxx user available message command codes. + *! 09-Nov-2000 rr: Added DSP_PROCEESORRESTART define; Removed DSP_PBUFFER. + *! Added DSP_DCD_ENOAUTOREGISTER, DSP_EUSER1-16, DSP_ESTRMFUL + *! Removed DSP_EDONE. Macros's modified. + *! 23-Oct-2000 jeh Replaced DSP_STREAMSTATECHANGE with DSP_STREAMDONE. + *! 09-Oct-2000 jeh Updated to version 0.9 DSP Bridge API spec. + *! 29-Sep-2000 kc Added error codes for DCD and REG to simplify use of + *! these codes within the RM module. + *! 27-Sep-2000 jeh Added segid, alignment, uNumBufs to DSP_STREAMATTRIN. + *! 29-Aug-2000 jeh Added DSP_NODETYPE enum, changed DSP_EALREADYATTACHED to + *! DSP_EALREADYCONNECTED. Changed scStreamConnection[1] + *! to scStreamConnection[16] in DSP_NODEINFO structure. + *! Added DSP_NOTIFICATION, DSP_STRMATTR. PSTRING changed + *! back to TCHAR * and moved to dbtype.h. + *! 11-Aug-2000 rr: Macros to check valid events and notify masks added. + *! 09-Aug-2000 rr: Changed PSTRING to *s8 + *! 07-Aug-2000 rr: PROC_IDLE/SYNCINIT/UNKNOWN state removed. + *! 20-Jul-2000 rr: Updated to version 0.8 + *! 17-Jul-2000 rr: New PROC states added to the DSP_PROCSTATE. + *! 27-Jun-2000 rr: Created from dspapi.h + */ + +#ifndef DBDEFS_ +#define DBDEFS_ + +#include + +#include /* GPP side type definitions */ +#include /* DSP/BIOS type definitions */ +#include /* Types shared between GPP and DSP */ + +#define PG_SIZE_4K 4096 +#define PG_MASK(pg_size) (~((pg_size)-1)) +#define PG_ALIGN_LOW(addr, pg_size) ((addr) & PG_MASK(pg_size)) +#define PG_ALIGN_HIGH(addr, pg_size) (((addr)+(pg_size)-1) & PG_MASK(pg_size)) + +/* API return value and calling convention */ +#define DBAPI DSP_STATUS CDECL + +/* Infinite time value for the uTimeout parameter to DSPStream_Select() */ +#define DSP_FOREVER (-1) + +/* Maximum length of node name, used in DSP_NDBPROPS */ +#define DSP_MAXNAMELEN 32 + +/* uNotifyType values for the RegisterNotify() functions. */ +#define DSP_SIGNALEVENT 0x00000001 + +/* Types of events for processors */ +#define DSP_PROCESSORSTATECHANGE 0x00000001 +#define DSP_PROCESSORATTACH 0x00000002 +#define DSP_PROCESSORDETACH 0x00000004 +#define DSP_PROCESSORRESTART 0x00000008 + +/* DSP exception events (DSP/BIOS and DSP MMU fault) */ +#define DSP_MMUFAULT 0x00000010 +#define DSP_SYSERROR 0x00000020 +#define DSP_EXCEPTIONABORT 0x00000300 + +/* IVA exception events (IVA MMU fault) */ +#define IVA_MMUFAULT 0x00000040 +/* Types of events for nodes */ +#define DSP_NODESTATECHANGE 0x00000100 +#define DSP_NODEMESSAGEREADY 0x00000200 + +/* Types of events for streams */ +#define DSP_STREAMDONE 0x00001000 +#define DSP_STREAMIOCOMPLETION 0x00002000 + +/* Handle definition representing the GPP node in DSPNode_Connect() calls */ +#define DSP_HGPPNODE 0xFFFFFFFF + +/* Node directions used in DSPNode_Connect() */ +#define DSP_TONODE 1 +#define DSP_FROMNODE 2 + +/* Define Node Minimum and Maximum Priorities */ +#define DSP_NODE_MIN_PRIORITY 1 +#define DSP_NODE_MAX_PRIORITY 15 + +/* Pre-Defined Message Command Codes available to user: */ +#define DSP_RMSUSERCODESTART RMS_USER /* Start of RMS user cmd codes */ +/* end of user codes */ +#define DSP_RMSUSERCODEEND (RMS_USER + RMS_MAXUSERCODES); +#define DSP_RMSBUFDESC RMS_BUFDESC /* MSG contains SM buffer description */ + +/* Shared memory identifier for MEM segment named "SHMSEG0" */ +#define DSP_SHMSEG0 (u32)(-1) + +/* Processor ID numbers */ +#define DSP_UNIT 0 +#define IVA_UNIT 1 + +#define DSPWORD unsigned char +#define DSPWORDSIZE sizeof(DSPWORD) + +/* Success & Failure macros */ +#define DSP_SUCCEEDED(Status) likely((s32)(Status) >= 0) +#define DSP_FAILED(Status) unlikely((s32)(Status) < 0) + +/* Power control enumerations */ +#define PROC_PWRCONTROL 0x8070 + +#define PROC_PWRMGT_ENABLE (PROC_PWRCONTROL + 0x3) +#define PROC_PWRMGT_DISABLE (PROC_PWRCONTROL + 0x4) + +/* Bridge Code Version */ +#define BRIDGE_VERSION_CODE 333 + +#define MAX_PROFILES 16 + +/* Types defined for 'Bridge API */ + typedef u32 DSP_STATUS; /* API return code type */ + + typedef HANDLE DSP_HNODE; /* Handle to a DSP Node object */ + typedef HANDLE DSP_HPROCESSOR; /* Handle to a Processor object */ + typedef HANDLE DSP_HSTREAM; /* Handle to a Stream object */ + + typedef u32 DSP_PROCFAMILY; /* Processor family */ + typedef u32 DSP_PROCTYPE; /* Processor type (w/in family) */ + typedef u32 DSP_RTOSTYPE; /* Type of DSP RTOS */ + +/* Handy Macros */ +#define IsValidProcEvent(x) (((x) == 0) || (((x) & (DSP_PROCESSORSTATECHANGE | \ + DSP_PROCESSORATTACH | \ + DSP_PROCESSORDETACH | \ + DSP_PROCESSORRESTART | \ + DSP_NODESTATECHANGE | \ + DSP_STREAMDONE | \ + DSP_STREAMIOCOMPLETION | \ + DSP_MMUFAULT | \ + DSP_SYSERROR)) && \ + !((x) & ~(DSP_PROCESSORSTATECHANGE | \ + DSP_PROCESSORATTACH | \ + DSP_PROCESSORDETACH | \ + DSP_PROCESSORRESTART | \ + DSP_NODESTATECHANGE | \ + DSP_STREAMDONE | \ + DSP_STREAMIOCOMPLETION | \ + DSP_MMUFAULT | \ + DSP_SYSERROR)))) + +#define IsValidNodeEvent(x) (((x) == 0) || (((x) & (DSP_NODESTATECHANGE | \ + DSP_NODEMESSAGEREADY)) && \ + !((x) & ~(DSP_NODESTATECHANGE | \ + DSP_NODEMESSAGEREADY)))) + +#define IsValidStrmEvent(x) (((x) == 0) || (((x) & (DSP_STREAMDONE | \ + DSP_STREAMIOCOMPLETION)) && \ + !((x) & ~(DSP_STREAMDONE | \ + DSP_STREAMIOCOMPLETION)))) + +#define IsValidNotifyMask(x) ((x) & DSP_SIGNALEVENT) + +/* The Node UUID structure */ + struct DSP_UUID { + u32 ulData1; + u16 usData2; + u16 usData3; + u8 ucData4; + u8 ucData5; + u8 ucData6[6]; + }; + +/* DCD types */ + enum DSP_DCDOBJTYPE { + DSP_DCDNODETYPE, + DSP_DCDPROCESSORTYPE, + DSP_DCDLIBRARYTYPE, + DSP_DCDCREATELIBTYPE, + DSP_DCDEXECUTELIBTYPE, + DSP_DCDDELETELIBTYPE + } ; + +/* Processor states */ + enum DSP_PROCSTATE { + PROC_STOPPED, + PROC_LOADED, + PROC_RUNNING + } ; + +/* Node types */ + enum DSP_NODETYPE { + NODE_DEVICE, + NODE_TASK, + NODE_DAISSOCKET, + NODE_MESSAGE + } ; + +/* Node states */ + enum DSP_NODESTATE { + NODE_ALLOCATED, + NODE_CREATED, + NODE_RUNNING, + NODE_PAUSED, + NODE_DONE + } ; + +/* Stream states */ + enum DSP_STREAMSTATE { + STREAM_IDLE, + STREAM_READY, + STREAM_PENDING, + STREAM_DONE + } ; + +/* Stream connect types */ + enum DSP_CONNECTTYPE { + CONNECTTYPE_NODEOUTPUT, + CONNECTTYPE_GPPOUTPUT, + CONNECTTYPE_NODEINPUT, + CONNECTTYPE_GPPINPUT + } ; + +/* Stream mode types */ + enum DSP_STRMMODE { + STRMMODE_PROCCOPY, /* Processor(s) copy stream data payloads */ + STRMMODE_ZEROCOPY, /* Strm buffer ptrs swapped no data copied */ + STRMMODE_LDMA, /* Local DMA : OMAP's System-DMA device */ + STRMMODE_RDMA /* Remote DMA: OMAP's DSP-DMA device */ + } ; + +/* Resource Types */ + enum DSP_RESOURCEINFOTYPE { + DSP_RESOURCE_DYNDARAM = 0, + DSP_RESOURCE_DYNSARAM, + DSP_RESOURCE_DYNEXTERNAL, + DSP_RESOURCE_DYNSRAM, + DSP_RESOURCE_PROCLOAD + } ; + +/* Memory Segment Types */ + enum DSP_MEMTYPE { + DSP_DYNDARAM = 0, + DSP_DYNSARAM, + DSP_DYNEXTERNAL, + DSP_DYNSRAM + } ; + +/* Memory Flush Types */ + enum DSP_FLUSHTYPE { + PROC_INVALIDATE_MEM = 0, + PROC_WRITEBACK_MEM, + PROC_WRITEBACK_INVALIDATE_MEM, + } ; + +/* Memory Segment Status Values */ + struct DSP_MEMSTAT { + u32 ulSize; + u32 ulTotalFreeSize; + u32 ulLenMaxFreeBlock; + u32 ulNumFreeBlocks; + u32 ulNumAllocBlocks; + } ; + +/* Processor Load information Values */ + struct DSP_PROCLOADSTAT { + u32 uCurrLoad; + u32 uPredictedLoad; + u32 uCurrDspFreq; + u32 uPredictedFreq; + } ; + +/* Attributes for STRM connections between nodes */ + struct DSP_STRMATTR { + u32 uSegid; /* Memory segment on DSP to allocate buffers */ + u32 uBufsize; /* Buffer size (DSP words) */ + u32 uNumBufs; /* Number of buffers */ + u32 uAlignment; /* Buffer alignment */ + u32 uTimeout; /* Timeout for blocking STRM calls */ + enum DSP_STRMMODE lMode; /* mode of stream when opened */ + /* DMA chnl id if DSP_STRMMODE is LDMA or RDMA */ + u32 uDMAChnlId; + u32 uDMAPriority; /* DMA channel priority 0=lowest, >0=high */ + } ; + +/* The DSP_CBDATA structure */ + struct DSP_CBDATA { + u32 cbData; + u8 cData[1]; + } ; + +/* The DSP_MSG structure */ + struct DSP_MSG { + u32 dwCmd; + u32 dwArg1; + u32 dwArg2; + } ; + +/* The DSP_RESOURCEREQMTS structure for node's resource requirements */ + struct DSP_RESOURCEREQMTS { + u32 cbStruct; + u32 uStaticDataSize; + u32 uGlobalDataSize; + u32 uProgramMemSize; + u32 uWCExecutionTime; + u32 uWCPeriod; + u32 uWCDeadline; + u32 uAvgExectionTime; + u32 uMinimumPeriod; + } ; + +/* + * The DSP_STREAMCONNECT structure describes a stream connection + * between two nodes, or between a node and the GPP + */ + struct DSP_STREAMCONNECT { + u32 cbStruct; + enum DSP_CONNECTTYPE lType; + u32 uThisNodeStreamIndex; + DSP_HNODE hConnectedNode; + struct DSP_UUID uiConnectedNodeID; + u32 uConnectedNodeStreamIndex; + } ; + +#if defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP3430) + struct DSP_NODEPROFS { + u32 ulHeapSize; + } ; +#endif + +/* The DSP_NDBPROPS structure reports the attributes of a node */ + struct DSP_NDBPROPS { + u32 cbStruct; + struct DSP_UUID uiNodeID; + char acName[DSP_MAXNAMELEN]; + enum DSP_NODETYPE uNodeType; + u32 bCacheOnGPP; + struct DSP_RESOURCEREQMTS dspResourceReqmts; + s32 iPriority; + u32 uStackSize; + u32 uSysStackSize; + u32 uStackSeg; + u32 uMessageDepth; + u32 uNumInputStreams; + u32 uNumOutputStreams; + u32 uTimeout; + u32 uCountProfiles; /* Number of supported profiles */ + /* Array of profiles */ + struct DSP_NODEPROFS aProfiles[MAX_PROFILES]; + u32 uStackSegName; /* Stack Segment Name */ + } ; + + /* The DSP_NODEATTRIN structure describes the attributes of a + * node client */ + struct DSP_NODEATTRIN { + u32 cbStruct; + s32 iPriority; + u32 uTimeout; + u32 uProfileID; + /* Reserved, for Bridge Internal use only */ + u32 uHeapSize; + void *pGPPVirtAddr; /* Reserved, for Bridge Internal use only */ + } ; + + /* The DSP_NODEINFO structure is used to retrieve information + * about a node */ + struct DSP_NODEINFO { + u32 cbStruct; + struct DSP_NDBPROPS nbNodeDatabaseProps; + u32 uExecutionPriority; + enum DSP_NODESTATE nsExecutionState; + DSP_HNODE hDeviceOwner; + u32 uNumberStreams; + struct DSP_STREAMCONNECT scStreamConnection[16]; + u32 uNodeEnv; + } ; + + /* The DSP_NODEATTR structure describes the attributes of a node */ + struct DSP_NODEATTR { + u32 cbStruct; + struct DSP_NODEATTRIN inNodeAttrIn; + u32 uInputs; + u32 uOutputs; + struct DSP_NODEINFO iNodeInfo; + } ; + +/* + * Notification type: either the name of an opened event, or an event or + * window handle. + */ + struct DSP_NOTIFICATION { + char *psName; + HANDLE handle; + } ; + +/* The DSP_PROCESSORATTRIN structure describes the attributes of a processor */ + struct DSP_PROCESSORATTRIN{ + u32 cbStruct; + u32 uTimeout; + } ; + + enum chipTypes { + DSPTYPE_55 = 6, + IVA_ARM7 = 0x97, + DSPTYPE_64 = 0x99 + }; + +/* + * The DSP_PROCESSORINFO structure describes basic capabilities of a + * DSP processor + */ + struct DSP_PROCESSORINFO { + u32 cbStruct; + DSP_PROCFAMILY uProcessorFamily; + DSP_PROCTYPE uProcessorType; + u32 uClockRate; + u32 ulInternalMemSize; + u32 ulExternalMemSize; + u32 uProcessorID; + DSP_RTOSTYPE tyRunningRTOS; + s32 nNodeMinPriority; + s32 nNodeMaxPriority; + } ; + +/* Error information of last DSP exception signalled to the GPP */ + struct DSP_ERRORINFO { + u32 dwErrMask; + u32 dwVal1; + u32 dwVal2; + u32 dwVal3; + } ; + +/* The DSP_PROCESSORSTATE structure describes the state of a DSP processor */ + struct DSP_PROCESSORSTATE { + u32 cbStruct; + enum DSP_PROCSTATE iState; + struct DSP_ERRORINFO errInfo; + } ; + +/* + * The DSP_RESOURCEINFO structure is used to retrieve information about a + * processor's resources + */ + struct DSP_RESOURCEINFO { + u32 cbStruct; + enum DSP_RESOURCEINFOTYPE uResourceType; + union { + u32 ulResource; + struct DSP_MEMSTAT memStat; + struct DSP_PROCLOADSTAT procLoadStat; + } result; + } ; + +/* + * The DSP_STREAMATTRIN structure describes the attributes of a stream, + * including segment and alignment of data buffers allocated with + * DSPStream_AllocateBuffers(), if applicable + */ + struct DSP_STREAMATTRIN { + u32 cbStruct; + u32 uTimeout; + u32 uSegment; + u32 uAlignment; + u32 uNumBufs; + enum DSP_STRMMODE lMode; + u32 uDMAChnlId; + u32 uDMAPriority; + } ; + +/* The DSP_BUFFERATTR structure describes the attributes of a data buffer */ + struct DSP_BUFFERATTR { + u32 cbStruct; + u32 uSegment; + u32 uAlignment; + } ; + +/* + * The DSP_STREAMINFO structure is used to retrieve information + * about a stream. + */ + struct DSP_STREAMINFO { + u32 cbStruct; + u32 uNumberBufsAllowed; + u32 uNumberBufsInStream; + u32 ulNumberBytes; + HANDLE hSyncObjectHandle; + enum DSP_STREAMSTATE ssStreamState; + } ; + +/* DMM MAP attributes +It is a bit mask with each bit value indicating a specific attribute +bit 0 - GPP address type (user virtual=0, physical=1) +bit 1 - MMU Endianism (Big Endian=1, Little Endian=0) +bit 2 - MMU mixed page attribute (Mixed/ CPUES=1, TLBES =0) +bit 3 - MMU element size = 8bit (valid only for non mixed page entries) +bit 4 - MMU element size = 16bit (valid only for non mixed page entries) +bit 5 - MMU element size = 32bit (valid only for non mixed page entries) +bit 6 - MMU element size = 64bit (valid only for non mixed page entries) +*/ + +/* Types of mapping attributes */ + +/* MPU address is virtual and needs to be translated to physical addr */ +#define DSP_MAPVIRTUALADDR 0x00000000 +#define DSP_MAPPHYSICALADDR 0x00000001 + +/* Mapped data is big endian */ +#define DSP_MAPBIGENDIAN 0x00000002 +#define DSP_MAPLITTLEENDIAN 0x00000000 + +/* Element size is based on DSP r/w access size */ +#define DSP_MAPMIXEDELEMSIZE 0x00000004 + +/* + * Element size for MMU mapping (8, 16, 32, or 64 bit) + * Ignored if DSP_MAPMIXEDELEMSIZE enabled + */ +#define DSP_MAPELEMSIZE8 0x00000008 +#define DSP_MAPELEMSIZE16 0x00000010 +#define DSP_MAPELEMSIZE32 0x00000020 +#define DSP_MAPELEMSIZE64 0x00000040 + +#define DSP_MAPVMALLOCADDR 0x00000080 + +#define GEM_CACHE_LINE_SIZE 128 +#define GEM_L1P_PREFETCH_SIZE 128 + +#endif /* DBDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbg.h b/arch/arm/plat-omap/include/bridge/dbg.h new file mode 100644 index 0000000..9422630 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbg.h @@ -0,0 +1,110 @@ +/* + * arch/arm/plat-omap/include/bridge/dbg.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== dbg.h ======== + * Purpose: + * Provide debugging services for 'Bridge Mini Drivers. + * + * Public Functions: + * DBG_Exit + * DBG_Init + * DBG_Printf + * DBG_Trace + * + * Notes: + * WMD's must not call DBG_Init or DBG_Exit. + * + *! Revision History: + *! ================ + *! 03-Feb-2000 rr: DBG Levels redefined. + *! 29-Oct-1999 kc: Cleaned up for code review. + *! 10-Oct-1997 cr: Added DBG_Printf service. + *! 29-May-1996 gp: Removed WCD_ prefix. + *! 15-May-1996 gp: Created. + */ + +#ifndef DBG_ +#define DBG_ +#include +#include + +/* Levels of trace debug messages: */ +#define DBG_ENTER (u8)(0x01) /* Function entry point. */ +#define DBG_LEVEL1 (u8)(0x02) /* Display debugging state/varibles */ +#define DBG_LEVEL2 (u8)(0x04) /* Display debugging state/varibles */ +#define DBG_LEVEL3 (u8)(0x08) /* Display debugging state/varibles */ +#define DBG_LEVEL4 (u8)(0x10) /* Display debugging state/varibles */ +#define DBG_LEVEL5 (u8)(0x20) /* Module Init, Exit */ +#define DBG_LEVEL6 (u8)(0x40) /* Warn SERVICES Failures */ +#define DBG_LEVEL7 (u8)(0x80) /* Warn Critical Errors */ + +#if ((defined DEBUG) || (defined DDSP_DEBUG_PRODUCT)) && GT_TRACE + +/* + * ======== DBG_Exit ======== + * Purpose: + * Discontinue usage of module; free resources when reference count + * reaches 0. + * Parameters: + * Returns: + * Requires: + * DBG initialized. + * Ensures: + * Resources used by module are freed when cRef reaches zero. + */ + extern void DBG_Exit(); + +/* + * ======== DBG_Init ======== + * Purpose: + * Initializes private state of DBG module. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + */ + extern bool DBG_Init(); + +/* + * ======== DBG_Trace ======== + * Purpose: + * Output a trace message to the debugger, if the given trace level + * is unmasked. + * Parameters: + * bLevel: Trace level. + * pstrFormat: sprintf-style format string. + * ...: Arguments for format string. + * Returns: + * DSP_SOK: Success, or trace level masked. + * DSP_EFAIL: On Error. + * Requires: + * DBG initialized. + * Ensures: + * Debug message is printed to debugger output window, if trace level + * is unmasked. + */ + extern DSP_STATUS DBG_Trace(IN u8 bLevel, IN char *pstrFormat, ...); +#else + +#define DBG_Exit() +#define DBG_Init() true +#define DBG_Trace(bLevel, pstrFormat, args...) + +#endif /* ((defined DEBUG) || (defined DDSP_DEBUG_PRODUCT)) && GT_TRACE */ + +#endif /* DBG_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbl.h b/arch/arm/plat-omap/include/bridge/dbl.h new file mode 100644 index 0000000..0c16dca --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbl.h @@ -0,0 +1,354 @@ +/* + * arch/arm/plat-omap/include/bridge/dbl.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dbl.h ======== + * + *! Revision History + *! ================ + *! 19-Mar-2002 jeh Pass DBL_Symbol pointer to DBL_getAddr, DBL_getCAddr + *! to accomodate dynamic loader library. + *! 20-Nov-2001 jeh Removed DBL_loadArgs(). + *! 24-Sep-2001 jeh Code review changes. + *! 07-Sep-2001 jeh Added DBL_LoadSect(), DBL_UnloadSect(). + *! 05-Jun-2001 jeh Created based on zl.h. + */ + +#ifndef DBL_ +#define DBL_ + +#include +#include + +/* + * ======== DBL_close ======== + * Close library opened with DBL_open. + * Parameters: + * lib - Handle returned from DBL_open(). + * Returns: + * Requires: + * DBL initialized. + * Valid lib. + * Ensures: + */ + extern void DBL_close(struct DBL_LibraryObj *lib); + +/* + * ======== DBL_create ======== + * Create a target object by specifying the alloc, free, and write + * functions for the target. + * Parameters: + * pTarget - Location to store target handle on output. + * pAttrs - Attributes. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failed. + * Requires: + * DBL initialized. + * pAttrs != NULL. + * pTarget != NULL; + * Ensures: + * Success: *pTarget != NULL. + * Failure: *pTarget == NULL. + */ + extern DSP_STATUS DBL_create(struct DBL_TargetObj **pTarget, + struct DBL_Attrs *pAttrs); + +/* + * ======== DBL_delete ======== + * Delete target object and free resources for any loaded libraries. + * Parameters: + * target - Handle returned from DBL_Create(). + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * Ensures: + */ + extern void DBL_delete(struct DBL_TargetObj *target); + +/* + * ======== DBL_exit ======== + * Discontinue use of DBL module. + * Parameters: + * Returns: + * Requires: + * cRefs > 0. + * Ensures: + * cRefs >= 0. + */ + extern void DBL_exit(void); + +/* + * ======== DBL_getAddr ======== + * Get address of name in the specified library. + * Parameters: + * lib - Handle returned from DBL_open(). + * name - Name of symbol + * ppSym - Location to store symbol address on output. + * Returns: + * TRUE: Success. + * FALSE: Symbol not found. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pAddr != NULL. + * Ensures: + */ + extern bool DBL_getAddr(struct DBL_LibraryObj *lib, char *name, + struct DBL_Symbol **ppSym); + +/* + * ======== DBL_getAttrs ======== + * Retrieve the attributes of the target. + * Parameters: + * target - Handle returned from DBL_Create(). + * pAttrs - Location to store attributes on output. + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * pAttrs != NULL. + * Ensures: + */ + extern void DBL_getAttrs(struct DBL_TargetObj *target, + struct DBL_Attrs *pAttrs); + +/* + * ======== DBL_getCAddr ======== + * Get address of "C" name in the specified library. + * Parameters: + * lib - Handle returned from DBL_open(). + * name - Name of symbol + * ppSym - Location to store symbol address on output. + * Returns: + * TRUE: Success. + * FALSE: Symbol not found. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pAddr != NULL. + * Ensures: + */ + extern bool DBL_getCAddr(struct DBL_LibraryObj *lib, char *name, + struct DBL_Symbol **ppSym); + +/* + * ======== DBL_getEntry ======== + * Get program entry point. + * + * Parameters: + * lib - Handle returned from DBL_open(). + * pEntry - Location to store entry address on output. + * Returns: + * TRUE: Success. + * FALSE: Failure. + * Requires: + * DBL initialized. + * Valid lib. + * pEntry != NULL. + * Ensures: + */ + extern bool DBL_getEntry(struct DBL_LibraryObj *lib, u32 *pEntry); + +/* + * ======== DBL_getSect ======== + * Get address and size of a named section. + * Parameters: + * lib - Library handle returned from DBL_open(). + * name - Name of section. + * pAddr - Location to store section address on output. + * pSize - Location to store section size on output. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Section not found. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pAddr != NULL; + * pSize != NULL. + * Ensures: + */ + extern DSP_STATUS DBL_getSect(struct DBL_LibraryObj *lib, char *name, + u32 *pAddr, u32 *pSize); + +/* + * ======== DBL_init ======== + * Initialize DBL module. + * Parameters: + * Returns: + * TRUE: Success. + * FALSE: Failure. + * Requires: + * cRefs >= 0. + * Ensures: + * Success: cRefs > 0. + * Failure: cRefs >= 0. + */ + extern bool DBL_init(void); + +/* + * ======== DBL_load ======== + * Add symbols/code/data defined in file to that already present on + * the target. + * + * Parameters: + * lib - Library handle returned from DBL_open(). + * flags - Specifies whether loading code, data, and/or symbols. + * attrs - May contain write, alloc, and free functions. + * pulEntry - Location to store program entry on output. + * Returns: + * DSP_SOK: Success. + * DSP_EFREAD: File read failed. + * DSP_EFWRITE: Write to target failed. + * Requires: + * DBL initialized. + * Valid lib. + * pEntry != NULL. + * Ensures: + */ + extern DSP_STATUS DBL_load(struct DBL_LibraryObj *lib, DBL_Flags flags, + struct DBL_Attrs *attrs, u32 *pEntry); + +/* + * ======== DBL_loadSect ======== + * Load a named section from an library (for overlay support). + * Parameters: + * lib - Handle returned from DBL_open(). + * sectName - Name of section to load. + * attrs - Contains write function and handle to pass to it. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Section not found. + * DSP_EFWRITE: Write function failed. + * Requires: + * Valid lib. + * sectName != NULL. + * attrs != NULL. + * attrs->write != NULL. + * Ensures: + */ + extern DSP_STATUS DBL_loadSect(struct DBL_LibraryObj *lib, + char *sectName, + struct DBL_Attrs *attrs); + +/* + * ======== DBL_open ======== + * DBL_open() returns a library handle that can be used to load/unload + * the symbols/code/data via DBL_load()/DBL_unload(). + * Parameters: + * target - Handle returned from DBL_create(). + * file - Name of file to open. + * flags - Specifies whether to load symbols now. + * pLib - Location to store library handle on output. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failure. + * DSP_EFOPEN: File open failure. + * DSP_EFREAD: File read failure. + * DSP_ECORRUPTFILE: Unable to determine target type. + * Requires: + * DBL initialized. + * Valid target. + * file != NULL. + * pLib != NULL. + * struct DBL_Attrs fopen function non-NULL. + * Ensures: + * Success: Valid *pLib. + * Failure: *pLib == NULL. + */ + extern DSP_STATUS DBL_open(struct DBL_TargetObj *target, char *file, + DBL_Flags flags, + struct DBL_LibraryObj **pLib); + +/* + * ======== DBL_readSect ======== + * Read COFF section into a character buffer. + * Parameters: + * lib - Library handle returned from DBL_open(). + * name - Name of section. + * pBuf - Buffer to write section contents into. + * size - Buffer size + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Named section does not exists. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pBuf != NULL. + * size != 0. + * Ensures: + */ + extern DSP_STATUS DBL_readSect(struct DBL_LibraryObj *lib, char *name, + char *pBuf, u32 size); + +/* + * ======== DBL_setAttrs ======== + * Set the attributes of the target. + * Parameters: + * target - Handle returned from DBL_create(). + * pAttrs - New attributes. + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * pAttrs != NULL. + * Ensures: + */ + extern void DBL_setAttrs(struct DBL_TargetObj *target, + struct DBL_Attrs *pAttrs); + +/* + * ======== DBL_unload ======== + * Remove the symbols/code/data corresponding to the library lib. + * Parameters: + * lib - Handle returned from DBL_open(). + * attrs - Contains free() function and handle to pass to it. + * Returns: + * Requires: + * DBL initialized. + * Valid lib. + * Ensures: + */ + extern void DBL_unload(struct DBL_LibraryObj *lib, + struct DBL_Attrs *attrs); + +/* + * ======== DBL_unloadSect ======== + * Unload a named section from an library (for overlay support). + * Parameters: + * lib - Handle returned from DBL_open(). + * sectName - Name of section to load. + * attrs - Contains free() function and handle to pass to it. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Named section not found. + * Requires: + * DBL initialized. + * Valid lib. + * sectName != NULL. + * Ensures: + */ + extern DSP_STATUS DBL_unloadSect(struct DBL_LibraryObj *lib, + char *sectName, + struct DBL_Attrs *attrs); + +#endif /* DBL_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbldefs.h b/arch/arm/plat-omap/include/bridge/dbldefs.h new file mode 100644 index 0000000..46cc862 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbldefs.h @@ -0,0 +1,519 @@ +/* + * arch/arm/plat-omap/include/bridge/dbldefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dbldefs.h ======== + * + *! Revision History + *! ================ + *! 19-Mar-2002 jeh Added DBL_Fxns type (to make it easier to switch + *! between different loaders). + *! 28-Sep-2001 jeh Created from zl.h. + */ +#ifndef DBLDEFS_ +#define DBLDEFS_ + +/* + * Bit masks for DBL_Flags. + */ +#define DBL_NOLOAD 0x0 /* Don't load symbols, code, or data */ +#define DBL_SYMB 0x1 /* load symbols */ +#define DBL_CODE 0x2 /* load code */ +#define DBL_DATA 0x4 /* load data */ +#define DBL_DYNAMIC 0x8 /* dynamic load */ +#define DBL_BSS 0x20 /* Unitialized section */ + +#define DBL_MAXPATHLENGTH 255 + +#ifndef _SIZE_T /* Linux sets _SIZE_T on defining size_t */ +typedef unsigned int size_t; +#define _SIZE_T +#endif + +/* + * ======== DBL_Flags ======== + * Specifies whether to load code, data, or symbols + */ +typedef s32 DBL_Flags; + +/* + * ======== DBL_SectInfo ======== + * For collecting info on overlay sections + */ +struct DBL_SectInfo { + const char *name; /* name of section */ + u32 runAddr; /* run address of section */ + u32 loadAddr; /* load address of section */ + u32 size; /* size of section (target MAUs) */ + DBL_Flags type; /* Code, data, or BSS */ +} ; + +/* + * ======== DBL_Symbol ======== + * (Needed for dynamic load library) + */ +struct DBL_Symbol { + u32 value; +}; + +/* + * ======== DBL_AllocFxn ======== + * Allocate memory function. Allocate or reserve (if reserved == TRUE) + * "size" bytes of memory from segment "space" and return the address in + * *dspAddr (or starting at *dspAddr if reserve == TRUE). Returns 0 on + * success, or an error code on failure. + */ +typedef s32(*DBL_AllocFxn) (void *hdl, s32 space, u32 size, u32 align, + u32 *dspAddr, s32 segId, s32 req, bool reserved); + +/* + * ======== DBL_CinitFxn ======== + * Process .cinit records. + * Parameters: + * hdl - Opaque handle + * dspAddress - DSP address of .cinit section + * buf - Buffer containing .cinit section + * nBytes - Size of .cinit section (host bytes) + * mtype - Page? (does not need to be used) + * + * Returns: + * nBytes - Success + * < nBytes - Failure + * + * Note: Cinit processing can either be done by the DSP, in which case + * the .cinit section must have already been written, or on the host, + * in which case we need to use the data in buf. + */ +typedef s32(*DBL_CinitFxn) (void *hdl, u32 dspAddr, void *buf, + u32 nBytes, s32 mtype); + +/* + * ======== DBL_CloseFxn ======== + */ +typedef s32(*DBL_FCloseFxn) (void *); + +/* + * ======== DBL_FreeFxn ======== + * Free memory function. Free, or unreserve (if reserved == TRUE) "size" + * bytes of memory from segment "space" + */ +typedef bool(*DBL_FreeFxn) (void *hdl, u32 addr, s32 space, u32 size, + bool reserved); + +/* + * ======== DBL_FOpenFxn ======== + */ +typedef void *(*DBL_FOpenFxn) (const char *, const char *); + +/* + * ======== DBL_LogWriteFxn ======== + * Function to call when writing data from a section, to log the info. + * Can be NULL if no logging is required. + */ +typedef DSP_STATUS(*DBL_LogWriteFxn) (void *handle, struct DBL_SectInfo *sect, + u32 addr, u32 nBytes); + +/* + * ======== DBL_ReadFxn ======== + */ +typedef s32(*DBL_ReadFxn) (void *, size_t, size_t, void *); + +/* + * ======== DBL_SeekFxn ======== + */ +typedef s32(*DBL_SeekFxn) (void *, long, int); + +/* + * ======== DBL_SymLookup ======== + * Symbol lookup function - Find the symbol name and return its value. + * + * Parameters: + * handle - Opaque handle + * pArg - Opaque argument. + * name - Name of symbol to lookup. + * sym - Location to store address of symbol structure. + * + * Returns: + * TRUE: Success (symbol was found). + * FALSE: Failed to find symbol. + */ +typedef bool(*DBL_SymLookup) (void *handle, void *pArg, void *rmmHandle, + const char *name, struct DBL_Symbol **sym); + +/* + * ======== DBL_TellFxn ======== + */ +typedef s32(*DBL_TellFxn) (void *); + +/* + * ======== DBL_WriteFxn ======== + * Write memory function. Write "n" HOST bytes of memory to segment "mtype" + * starting at address "dspAddr" from the buffer "buf". The buffer is + * formatted as an array of words appropriate for the DSP. + */ +typedef s32(*DBL_WriteFxn) (void *hdl, u32 dspAddr, void *buf, + u32 n, s32 mtype); + +/* + * ======== DBL_Attrs ======== + */ +struct DBL_Attrs { + DBL_AllocFxn alloc; + DBL_FreeFxn free; + void *rmmHandle; /* Handle to pass to alloc, free functions */ + DBL_WriteFxn write; + void *wHandle; /* Handle to pass to write, cinit function */ + + DBL_LogWriteFxn logWrite; + void *logWriteHandle; + + /* Symbol matching function and handle to pass to it */ + DBL_SymLookup symLookup; + void *symHandle; + void *symArg; + + /* + * These file manipulation functions should be compatible with the + * "C" run time library functions of the same name. + */ + s32(*fread) (void *, size_t, size_t, void *); + s32(*fseek) (void *, long, int); + s32(*ftell) (void *); + s32(*fclose) (void *); + void *(*fopen) (const char *, const char *); +} ; + +/* + * ======== DBL_close ======== + * Close library opened with DBL_open. + * Parameters: + * lib - Handle returned from DBL_open(). + * Returns: + * Requires: + * DBL initialized. + * Valid lib. + * Ensures: + */ +typedef void(*DBL_CloseFxn) (struct DBL_LibraryObj *library); + +/* + * ======== DBL_create ======== + * Create a target object, specifying the alloc, free, and write functions. + * Parameters: + * pTarget - Location to store target handle on output. + * pAttrs - Attributes. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failed. + * Requires: + * DBL initialized. + * pAttrs != NULL. + * pTarget != NULL; + * Ensures: + * Success: *pTarget != NULL. + * Failure: *pTarget == NULL. + */ +typedef DSP_STATUS(*DBL_CreateFxn) (struct DBL_TargetObj **pTarget, + struct DBL_Attrs *attrs); + +/* + * ======== DBL_delete ======== + * Delete target object and free resources for any loaded libraries. + * Parameters: + * target - Handle returned from DBL_Create(). + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * Ensures: + */ +typedef void(*DBL_DeleteFxn) (struct DBL_TargetObj *target); + +/* + * ======== DBL_exit ======== + * Discontinue use of DBL module. + * Parameters: + * Returns: + * Requires: + * cRefs > 0. + * Ensures: + * cRefs >= 0. + */ +typedef void(*DBL_ExitFxn) (void); + +/* + * ======== DBL_getAddr ======== + * Get address of name in the specified library. + * Parameters: + * lib - Handle returned from DBL_open(). + * name - Name of symbol + * ppSym - Location to store symbol address on output. + * Returns: + * TRUE: Success. + * FALSE: Symbol not found. + * Requires: + * DBL initialized. + * Valid library. + * name != NULL. + * ppSym != NULL. + * Ensures: + */ +typedef bool(*DBL_GetAddrFxn) (struct DBL_LibraryObj *lib, char *name, + struct DBL_Symbol **ppSym); + +/* + * ======== DBL_getAttrs ======== + * Retrieve the attributes of the target. + * Parameters: + * target - Handle returned from DBL_Create(). + * pAttrs - Location to store attributes on output. + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * pAttrs != NULL. + * Ensures: + */ +typedef void(*DBL_GetAttrsFxn) (struct DBL_TargetObj *target, + struct DBL_Attrs *attrs); + +/* + * ======== DBL_getCAddr ======== + * Get address of "C" name on the specified library. + * Parameters: + * lib - Handle returned from DBL_open(). + * name - Name of symbol + * ppSym - Location to store symbol address on output. + * Returns: + * TRUE: Success. + * FALSE: Symbol not found. + * Requires: + * DBL initialized. + * Valid target. + * name != NULL. + * ppSym != NULL. + * Ensures: + */ +typedef bool(*DBL_GetCAddrFxn) (struct DBL_LibraryObj *lib, char *name, + struct DBL_Symbol **ppSym); + +/* + * ======== DBL_getSect ======== + * Get address and size of a named section. + * Parameters: + * lib - Library handle returned from DBL_open(). + * name - Name of section. + * pAddr - Location to store section address on output. + * pSize - Location to store section size on output. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Section not found. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pAddr != NULL; + * pSize != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBL_GetSectFxn) (struct DBL_LibraryObj *lib, char *name, + u32 *addr, u32 *size); + +/* + * ======== DBL_init ======== + * Initialize DBL module. + * Parameters: + * Returns: + * TRUE: Success. + * FALSE: Failure. + * Requires: + * cRefs >= 0. + * Ensures: + * Success: cRefs > 0. + * Failure: cRefs >= 0. + */ +typedef bool(*DBL_InitFxn) (void); + +/* + * ======== DBL_load ======== + * Load library onto the target. + * + * Parameters: + * lib - Library handle returned from DBL_open(). + * flags - Load code, data and/or symbols. + * attrs - May contain alloc, free, and write function. + * pulEntry - Location to store program entry on output. + * Returns: + * DSP_SOK: Success. + * DSP_EFREAD: File read failed. + * DSP_EFWRITE: Write to target failed. + * DSP_EDYNLOAD: Failure in dynamic loader library. + * Requires: + * DBL initialized. + * Valid lib. + * pEntry != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBL_LoadFxn) (struct DBL_LibraryObj *lib, DBL_Flags flags, + struct DBL_Attrs *attrs, u32 *entry); + +/* + * ======== DBL_loadSect ======== + * Load a named section from an library (for overlay support). + * Parameters: + * lib - Handle returned from DBL_open(). + * sectName - Name of section to load. + * attrs - Contains write function and handle to pass to it. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Section not found. + * DSP_EFWRITE: Write function failed. + * DSP_ENOTIMPL: Function not implemented. + * Requires: + * Valid lib. + * sectName != NULL. + * attrs != NULL. + * attrs->write != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBL_LoadSectFxn) (struct DBL_LibraryObj *lib, + char *pszSectName, + struct DBL_Attrs *attrs); + +/* + * ======== DBL_open ======== + * DBL_open() returns a library handle that can be used to load/unload + * the symbols/code/data via DBL_load()/DBL_unload(). + * Parameters: + * target - Handle returned from DBL_create(). + * file - Name of file to open. + * flags - If flags & DBL_SYMB, load symbols. + * pLib - Location to store library handle on output. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failure. + * DSP_EFOPEN: File open failure. + * DSP_EFREAD: File read failure. + * DSP_ECORRUPTFILE: Unable to determine target type. + * Requires: + * DBL initialized. + * Valid target. + * file != NULL. + * pLib != NULL. + * DBL_Attrs fopen function non-NULL. + * Ensures: + * Success: Valid *pLib. + * Failure: *pLib == NULL. + */ +typedef DSP_STATUS(*DBL_OpenFxn) (struct DBL_TargetObj *target, char *file, + DBL_Flags flags, + struct DBL_LibraryObj **pLib); + +/* + * ======== DBL_readSect ======== + * Read COFF section into a character buffer. + * Parameters: + * lib - Library handle returned from DBL_open(). + * name - Name of section. + * pBuf - Buffer to write section contents into. + * size - Buffer size + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Named section does not exists. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pBuf != NULL. + * size != 0. + * Ensures: + */ +typedef DSP_STATUS(*DBL_ReadSectFxn) (struct DBL_LibraryObj *lib, char *name, + char *content, u32 uContentSize); + +/* + * ======== DBL_setAttrs ======== + * Set the attributes of the target. + * Parameters: + * target - Handle returned from DBL_create(). + * pAttrs - New attributes. + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * pAttrs != NULL. + * Ensures: + */ +typedef void(*DBL_SetAttrsFxn) (struct DBL_TargetObj *target, + struct DBL_Attrs *attrs); + +/* + * ======== DBL_unload ======== + * Unload library loaded with DBL_load(). + * Parameters: + * lib - Handle returned from DBL_open(). + * attrs - Contains free() function and handle to pass to it. + * Returns: + * Requires: + * DBL initialized. + * Valid lib. + * Ensures: + */ +typedef void(*DBL_UnloadFxn) (struct DBL_LibraryObj *library, + struct DBL_Attrs *attrs); + +/* + * ======== DBL_unloadSect ======== + * Unload a named section from an library (for overlay support). + * Parameters: + * lib - Handle returned from DBL_open(). + * sectName - Name of section to load. + * attrs - Contains free() function and handle to pass to it. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Named section not found. + * DSP_ENOTIMPL + * Requires: + * DBL initialized. + * Valid lib. + * sectName != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBL_UnloadSectFxn) (struct DBL_LibraryObj *lib, + char *pszSectName, + struct DBL_Attrs *attrs); + +struct DBL_Fxns { + DBL_CloseFxn closeFxn; + DBL_CreateFxn createFxn; + DBL_DeleteFxn deleteFxn; + DBL_ExitFxn exitFxn; + DBL_GetAttrsFxn getAttrsFxn; + DBL_GetAddrFxn getAddrFxn; + DBL_GetCAddrFxn getCAddrFxn; + DBL_GetSectFxn getSectFxn; + DBL_InitFxn initFxn; + DBL_LoadFxn loadFxn; + DBL_LoadSectFxn loadSectFxn; + DBL_OpenFxn openFxn; + DBL_ReadSectFxn readSectFxn; + DBL_SetAttrsFxn setAttrsFxn; + DBL_UnloadFxn unloadFxn; + DBL_UnloadSectFxn unloadSectFxn; +}; + +#endif /* DBLDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbll.h b/arch/arm/plat-omap/include/bridge/dbll.h new file mode 100644 index 0000000..03bf027 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbll.h @@ -0,0 +1,70 @@ +/* + * arch/arm/plat-omap/include/bridge/dbll.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dbll.h ======== + * DSP/BIOS Bridge Dynamic load library module interface. Function header + * comments are in the file dblldefs.h. + * + *! Revision History + *! ================ + *! 31-Jul-2002 jeh Removed function comments (now in dblldefs.h). + *! 17-Apr-2002 jeh Created based on zl.h. + */ + +#ifndef DBLL_ +#define DBLL_ + +#include +#include + + extern void DBLL_close(struct DBLL_LibraryObj *lib); + extern DSP_STATUS DBLL_create(struct DBLL_TarObj **pTarget, + struct DBLL_Attrs *pAttrs); + extern void DBLL_delete(struct DBLL_TarObj *target); + extern void DBLL_exit(void); + extern bool DBLL_getAddr(struct DBLL_LibraryObj *lib, char *name, + struct DBLL_Symbol **ppSym); + extern void DBLL_getAttrs(struct DBLL_TarObj *target, + struct DBLL_Attrs *pAttrs); + extern bool DBLL_getCAddr(struct DBLL_LibraryObj *lib, char *name, + struct DBLL_Symbol **ppSym); + extern DSP_STATUS DBLL_getSect(struct DBLL_LibraryObj *lib, char *name, + u32 *pAddr, u32 *pSize); + extern bool DBLL_init(void); + extern DSP_STATUS DBLL_load(struct DBLL_LibraryObj *lib, + DBLL_Flags flags, + struct DBLL_Attrs *attrs, u32 *pEntry); + extern DSP_STATUS DBLL_loadSect(struct DBLL_LibraryObj *lib, + char *sectName, + struct DBLL_Attrs *attrs); + extern DSP_STATUS DBLL_open(struct DBLL_TarObj *target, char *file, + DBLL_Flags flags, + struct DBLL_LibraryObj **pLib); + extern DSP_STATUS DBLL_readSect(struct DBLL_LibraryObj *lib, + char *name, + char *pBuf, u32 size); + extern void DBLL_setAttrs(struct DBLL_TarObj *target, + struct DBLL_Attrs *pAttrs); + extern void DBLL_unload(struct DBLL_LibraryObj *lib, + struct DBLL_Attrs *attrs); + extern DSP_STATUS DBLL_unloadSect(struct DBLL_LibraryObj *lib, + char *sectName, + struct DBLL_Attrs *attrs); + +#endif /* DBLL_ */ + diff --git a/arch/arm/plat-omap/include/bridge/dblldefs.h b/arch/arm/plat-omap/include/bridge/dblldefs.h new file mode 100644 index 0000000..261fbf9 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dblldefs.h @@ -0,0 +1,513 @@ +/* + * arch/arm/plat-omap/include/bridge/dblldefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dblldefs.h ======== + * + *! Revision History + *! ================ + *! 08-Apr-2003 map Consolidated DBL into DBLL name + *! 19-Mar-2002 jeh Added DBL_Fxns type (to make it easier to switch + *! between different loaders). + *! 28-Sep-2001 jeh Created from zl.h. + */ +#ifndef DBLLDEFS_ +#define DBLLDEFS_ + +/* + * Bit masks for DBL_Flags. + */ +#define DBLL_NOLOAD 0x0 /* Don't load symbols, code, or data */ +#define DBLL_SYMB 0x1 /* load symbols */ +#define DBLL_CODE 0x2 /* load code */ +#define DBLL_DATA 0x4 /* load data */ +#define DBLL_DYNAMIC 0x8 /* dynamic load */ +#define DBLL_BSS 0x20 /* Unitialized section */ + +#define DBLL_MAXPATHLENGTH 255 + +#ifndef _SIZE_T +typedef unsigned int size_t; +#define _SIZE_T +#endif + +/* + * ======== DBLL_Target ======== + * + */ +struct DBLL_TarObj; + +/* + * ======== DBLL_Flags ======== + * Specifies whether to load code, data, or symbols + */ +typedef s32 DBLL_Flags; + +/* + * ======== DBLL_Library ======== + * + */ +struct DBLL_LibraryObj; + +/* + * ======== DBLL_SectInfo ======== + * For collecting info on overlay sections + */ +struct DBLL_SectInfo { + const char *name; /* name of section */ + u32 runAddr; /* run address of section */ + u32 loadAddr; /* load address of section */ + u32 size; /* size of section (target MAUs) */ + DBLL_Flags type; /* Code, data, or BSS */ +} ; + +/* + * ======== DBLL_Symbol ======== + * (Needed for dynamic load library) + */ +struct DBLL_Symbol { + u32 value; +}; + +/* + * ======== DBLL_AllocFxn ======== + * Allocate memory function. Allocate or reserve (if reserved == TRUE) + * "size" bytes of memory from segment "space" and return the address in + * *dspAddr (or starting at *dspAddr if reserve == TRUE). Returns 0 on + * success, or an error code on failure. + */ +typedef s32(*DBLL_AllocFxn) (void *hdl, s32 space, u32 size, u32 align, + u32 *dspAddr, s32 segId, s32 req, + bool reserved); + +/* + * ======== DBLL_CloseFxn ======== + */ +typedef s32(*DBLL_FCloseFxn) (void *); + +/* + * ======== DBLL_FreeFxn ======== + * Free memory function. Free, or unreserve (if reserved == TRUE) "size" + * bytes of memory from segment "space" + */ +typedef bool(*DBLL_FreeFxn) (void *hdl, u32 addr, s32 space, u32 size, + bool reserved); + +/* + * ======== DBLL_FOpenFxn ======== + */ +typedef void *(*DBLL_FOpenFxn) (const char *, const char *); + +/* + * ======== DBLL_LogWriteFxn ======== + * Function to call when writing data from a section, to log the info. + * Can be NULL if no logging is required. + */ +typedef DSP_STATUS(*DBLL_LogWriteFxn)(void *handle, struct DBLL_SectInfo *sect, + u32 addr, u32 nBytes); + +/* + * ======== DBLL_ReadFxn ======== + */ +typedef s32(*DBLL_ReadFxn) (void *, size_t, size_t, void *); + +/* + * ======== DBLL_SeekFxn ======== + */ +typedef s32(*DBLL_SeekFxn) (void *, long, int); + +/* + * ======== DBLL_SymLookup ======== + * Symbol lookup function - Find the symbol name and return its value. + * + * Parameters: + * handle - Opaque handle + * pArg - Opaque argument. + * name - Name of symbol to lookup. + * sym - Location to store address of symbol structure. + * + * Returns: + * TRUE: Success (symbol was found). + * FALSE: Failed to find symbol. + */ +typedef bool(*DBLL_SymLookup) (void *handle, void *pArg, void *rmmHandle, + const char *name, struct DBLL_Symbol **sym); + +/* + * ======== DBLL_TellFxn ======== + */ +typedef s32(*DBLL_TellFxn) (void *); + +/* + * ======== DBLL_WriteFxn ======== + * Write memory function. Write "n" HOST bytes of memory to segment "mtype" + * starting at address "dspAddr" from the buffer "buf". The buffer is + * formatted as an array of words appropriate for the DSP. + */ +typedef s32(*DBLL_WriteFxn) (void *hdl, u32 dspAddr, void *buf, + u32 n, s32 mtype); + +/* + * ======== DBLL_Attrs ======== + */ +struct DBLL_Attrs { + DBLL_AllocFxn alloc; + DBLL_FreeFxn free; + void *rmmHandle; /* Handle to pass to alloc, free functions */ + DBLL_WriteFxn write; + void *wHandle; /* Handle to pass to write, cinit function */ + bool baseImage; + DBLL_LogWriteFxn logWrite; + void *logWriteHandle; + + /* Symbol matching function and handle to pass to it */ + DBLL_SymLookup symLookup; + void *symHandle; + void *symArg; + + /* + * These file manipulation functions should be compatible with the + * "C" run time library functions of the same name. + */ + s32(*fread) (void *, size_t, size_t, void *); + s32(*fseek) (void *, long, int); + s32(*ftell) (void *); + s32(*fclose) (void *); + void *(*fopen) (const char *, const char *); +} ; + +/* + * ======== DBLL_close ======== + * Close library opened with DBLL_open. + * Parameters: + * lib - Handle returned from DBLL_open(). + * Returns: + * Requires: + * DBL initialized. + * Valid lib. + * Ensures: + */ +typedef void(*DBLL_CloseFxn) (struct DBLL_LibraryObj *library); + +/* + * ======== DBLL_create ======== + * Create a target object, specifying the alloc, free, and write functions. + * Parameters: + * pTarget - Location to store target handle on output. + * pAttrs - Attributes. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failed. + * Requires: + * DBL initialized. + * pAttrs != NULL. + * pTarget != NULL; + * Ensures: + * Success: *pTarget != NULL. + * Failure: *pTarget == NULL. + */ +typedef DSP_STATUS(*DBLL_CreateFxn)(struct DBLL_TarObj **pTarget, + struct DBLL_Attrs *attrs); + +/* + * ======== DBLL_delete ======== + * Delete target object and free resources for any loaded libraries. + * Parameters: + * target - Handle returned from DBLL_Create(). + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * Ensures: + */ +typedef void(*DBLL_DeleteFxn) (struct DBLL_TarObj *target); + +/* + * ======== DBLL_exit ======== + * Discontinue use of DBL module. + * Parameters: + * Returns: + * Requires: + * cRefs > 0. + * Ensures: + * cRefs >= 0. + */ +typedef void(*DBLL_ExitFxn) (void); + +/* + * ======== DBLL_getAddr ======== + * Get address of name in the specified library. + * Parameters: + * lib - Handle returned from DBLL_open(). + * name - Name of symbol + * ppSym - Location to store symbol address on output. + * Returns: + * TRUE: Success. + * FALSE: Symbol not found. + * Requires: + * DBL initialized. + * Valid library. + * name != NULL. + * ppSym != NULL. + * Ensures: + */ +typedef bool(*DBLL_GetAddrFxn) (struct DBLL_LibraryObj *lib, char *name, + struct DBLL_Symbol **ppSym); + +/* + * ======== DBLL_getAttrs ======== + * Retrieve the attributes of the target. + * Parameters: + * target - Handle returned from DBLL_Create(). + * pAttrs - Location to store attributes on output. + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * pAttrs != NULL. + * Ensures: + */ +typedef void(*DBLL_GetAttrsFxn) (struct DBLL_TarObj *target, + struct DBLL_Attrs *attrs); + +/* + * ======== DBLL_getCAddr ======== + * Get address of "C" name on the specified library. + * Parameters: + * lib - Handle returned from DBLL_open(). + * name - Name of symbol + * ppSym - Location to store symbol address on output. + * Returns: + * TRUE: Success. + * FALSE: Symbol not found. + * Requires: + * DBL initialized. + * Valid target. + * name != NULL. + * ppSym != NULL. + * Ensures: + */ +typedef bool(*DBLL_GetCAddrFxn) (struct DBLL_LibraryObj *lib, char *name, + struct DBLL_Symbol **ppSym); + +/* + * ======== DBLL_getSect ======== + * Get address and size of a named section. + * Parameters: + * lib - Library handle returned from DBLL_open(). + * name - Name of section. + * pAddr - Location to store section address on output. + * pSize - Location to store section size on output. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Section not found. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pAddr != NULL; + * pSize != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBLL_GetSectFxn) (struct DBLL_LibraryObj *lib, char *name, + u32 *addr, u32 *size); + +/* + * ======== DBLL_init ======== + * Initialize DBL module. + * Parameters: + * Returns: + * TRUE: Success. + * FALSE: Failure. + * Requires: + * cRefs >= 0. + * Ensures: + * Success: cRefs > 0. + * Failure: cRefs >= 0. + */ +typedef bool(*DBLL_InitFxn) (void); + +/* + * ======== DBLL_load ======== + * Load library onto the target. + * + * Parameters: + * lib - Library handle returned from DBLL_open(). + * flags - Load code, data and/or symbols. + * attrs - May contain alloc, free, and write function. + * pulEntry - Location to store program entry on output. + * Returns: + * DSP_SOK: Success. + * DSP_EFREAD: File read failed. + * DSP_EFWRITE: Write to target failed. + * DSP_EDYNLOAD: Failure in dynamic loader library. + * Requires: + * DBL initialized. + * Valid lib. + * pEntry != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBLL_LoadFxn) (struct DBLL_LibraryObj *lib, + DBLL_Flags flags, + struct DBLL_Attrs *attrs, u32 *entry); + +/* + * ======== DBLL_loadSect ======== + * Load a named section from an library (for overlay support). + * Parameters: + * lib - Handle returned from DBLL_open(). + * sectName - Name of section to load. + * attrs - Contains write function and handle to pass to it. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Section not found. + * DSP_EFWRITE: Write function failed. + * DSP_ENOTIMPL: Function not implemented. + * Requires: + * Valid lib. + * sectName != NULL. + * attrs != NULL. + * attrs->write != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBLL_LoadSectFxn) (struct DBLL_LibraryObj *lib, + char *pszSectName, + struct DBLL_Attrs *attrs); + +/* + * ======== DBLL_open ======== + * DBLL_open() returns a library handle that can be used to load/unload + * the symbols/code/data via DBLL_load()/DBLL_unload(). + * Parameters: + * target - Handle returned from DBLL_create(). + * file - Name of file to open. + * flags - If flags & DBLL_SYMB, load symbols. + * pLib - Location to store library handle on output. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failure. + * DSP_EFOPEN: File open failure. + * DSP_EFREAD: File read failure. + * DSP_ECORRUPTFILE: Unable to determine target type. + * Requires: + * DBL initialized. + * Valid target. + * file != NULL. + * pLib != NULL. + * DBLL_Attrs fopen function non-NULL. + * Ensures: + * Success: Valid *pLib. + * Failure: *pLib == NULL. + */ +typedef DSP_STATUS(*DBLL_OpenFxn) (struct DBLL_TarObj *target, char *file, + DBLL_Flags flags, + struct DBLL_LibraryObj **pLib); + +/* + * ======== DBLL_readSect ======== + * Read COFF section into a character buffer. + * Parameters: + * lib - Library handle returned from DBLL_open(). + * name - Name of section. + * pBuf - Buffer to write section contents into. + * size - Buffer size + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Named section does not exists. + * Requires: + * DBL initialized. + * Valid lib. + * name != NULL. + * pBuf != NULL. + * size != 0. + * Ensures: + */ +typedef DSP_STATUS(*DBLL_ReadSectFxn) (struct DBLL_LibraryObj *lib, char *name, + char *content, u32 uContentSize); + +/* + * ======== DBLL_setAttrs ======== + * Set the attributes of the target. + * Parameters: + * target - Handle returned from DBLL_create(). + * pAttrs - New attributes. + * Returns: + * Requires: + * DBL initialized. + * Valid target. + * pAttrs != NULL. + * Ensures: + */ +typedef void(*DBLL_SetAttrsFxn)(struct DBLL_TarObj *target, + struct DBLL_Attrs *attrs); + +/* + * ======== DBLL_unload ======== + * Unload library loaded with DBLL_load(). + * Parameters: + * lib - Handle returned from DBLL_open(). + * attrs - Contains free() function and handle to pass to it. + * Returns: + * Requires: + * DBL initialized. + * Valid lib. + * Ensures: + */ +typedef void(*DBLL_UnloadFxn) (struct DBLL_LibraryObj *library, + struct DBLL_Attrs *attrs); + +/* + * ======== DBLL_unloadSect ======== + * Unload a named section from an library (for overlay support). + * Parameters: + * lib - Handle returned from DBLL_open(). + * sectName - Name of section to load. + * attrs - Contains free() function and handle to pass to it. + * Returns: + * DSP_SOK: Success. + * DSP_ENOSECT: Named section not found. + * DSP_ENOTIMPL + * Requires: + * DBL initialized. + * Valid lib. + * sectName != NULL. + * Ensures: + */ +typedef DSP_STATUS(*DBLL_UnloadSectFxn) (struct DBLL_LibraryObj *lib, + char *pszSectName, + struct DBLL_Attrs *attrs); + +struct DBLL_Fxns { + DBLL_CloseFxn closeFxn; + DBLL_CreateFxn createFxn; + DBLL_DeleteFxn deleteFxn; + DBLL_ExitFxn exitFxn; + DBLL_GetAttrsFxn getAttrsFxn; + DBLL_GetAddrFxn getAddrFxn; + DBLL_GetCAddrFxn getCAddrFxn; + DBLL_GetSectFxn getSectFxn; + DBLL_InitFxn initFxn; + DBLL_LoadFxn loadFxn; + DBLL_LoadSectFxn loadSectFxn; + DBLL_OpenFxn openFxn; + DBLL_ReadSectFxn readSectFxn; + DBLL_SetAttrsFxn setAttrsFxn; + DBLL_UnloadFxn unloadFxn; + DBLL_UnloadSectFxn unloadSectFxn; +} ; + +#endif /* DBLDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbof.h b/arch/arm/plat-omap/include/bridge/dbof.h new file mode 100644 index 0000000..5c0b4f6 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbof.h @@ -0,0 +1,117 @@ +/* + * arch/arm/plat-omap/include/bridge/dbof.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dbof.h ======== + * Description: + * Defines and typedefs for DSP/BIOS Bridge Object File Format (DBOF). + * + *! Revision History + *! ================ + *! 12-Jul-2002 jeh Added defines for DBOF_SectHdr page. + *! 12-Oct-2001 jeh Converted to std.h format. + *! 07-Sep-2001 jeh Added overlay support. + *! 06-Jul-2001 jeh Created. + */ + +#ifndef DBOF_ +#define DBOF_ + +/* Enough to hold DCD section names: 32 digit ID + underscores */ +#define DBOF_DCDSECTNAMELEN 40 + +/* Values for DBOF_SectHdr page field. */ +#define DBOF_PROGRAM 0 +#define DBOF_DATA 1 +#define DBOF_CINIT 2 + +/* + * ======== DBOF_FileHdr ======== + */ + struct DBOF_FileHdr { + u32 magic; /* COFF magic number */ + u32 entry; /* Program entry point */ + u16 numSymbols; /* Number of bridge symbols */ + u16 numDCDSects; /* Number of DCD sections */ + u16 numSects; /* Number of sections to load */ + u16 numOvlySects; /* Number of overlay sections */ + u32 symOffset; /* Offset in file to symbols */ + u32 dcdSectOffset; /* Offset to DCD sections */ + u32 loadSectOffset; /* Offset to loadable sections */ + u32 ovlySectOffset; /* Offset to overlay data */ + u16 version; /* DBOF version number */ + u16 resvd; /* Reserved for future use */ + } ; + +/* + * ======== DBOF_DCDSectHdr ======== + */ + struct DBOF_DCDSectHdr { + u32 size; /* Sect size (target MAUs) */ + char name[DBOF_DCDSECTNAMELEN]; /* DCD section name */ + } ; + +/* + * ======== DBOF_OvlySectHdr ======== + */ + struct DBOF_OvlySectHdr { + u16 nameLen; /* Length of section name */ + u16 numCreateSects; /* # of sects loaded for create phase */ + u16 numDeleteSects; /* # of sects loaded for delete phase */ + u16 numExecuteSects; /* # of sects loaded for execute phase */ + + /* + * Number of sections where load/unload phase is not specified. + * These sections will be loaded when create phase sects are + * loaded, and unloaded when the delete phase is unloaded. + */ + u16 numOtherSects; + u16 resvd; /* Reserved for future use */ + }; + +/* + * ======== DBOF_OvlySectData ======== + */ + struct DBOF_OvlySectData { + u32 loadAddr; /* Section load address */ + u32 runAddr; /* Section run address */ + u32 size; /* Section size (target MAUs) */ + u16 page; /* Memory page number */ + u16 resvd; /* Reserved */ + } ; + +/* + * ======== DBOF_SectHdr ======== + */ + struct DBOF_SectHdr { + u32 addr; /* Section address */ + u32 size; /* Section size (target MAUs) */ + u16 page; /* Page number */ + u16 resvd; /* Reserved for future use */ + } ; + +/* + * ======== DBOF_SymbolHdr ======== + */ + struct DBOF_SymbolHdr { + u32 value; /* Symbol value */ + u16 nameLen; /* Length of symbol name */ + u16 resvd; /* Reserved for future use */ + } ; + +#endif /* DBOF_ */ + diff --git a/arch/arm/plat-omap/include/bridge/dbreg.h b/arch/arm/plat-omap/include/bridge/dbreg.h new file mode 100644 index 0000000..ea44032 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbreg.h @@ -0,0 +1,113 @@ +/* + * arch/arm/plat-omap/include/bridge/dbreg.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dbreg.h ======== + * Purpose: + * Registry keys for use in Linux. This is the clearinghouse for + * registry definitions, hopefully eliminating overlapping between + * modules. + * + *! Revision History: + *! ================ + *! 10-Apr-2003 vp: Added macro for subkey TCWORDSWAP. + *! 21-Mar-2003 sb: Added macro for subkey SHMSize + *! 27-Aug-2001 jeh Added WSXREG_LOADERFILENAME. + *! 13-Feb-2001 kc: DSP/BIOS Bridge name updates. + *! 29-Nov-2000 rr: Added WSXREG_DSPTYPE_55 as 6. + *! 06-Sep-2000 jeh: Added WSXREG_CHNLOFFSET, WSXREG_NUMCHNLS, + *! WSXREG_CHNLBUFSIZE. + *! 26-Aug-2000 rr: MEMBASE expanded to 9 entries. + *! 26-Jul-2000 rr: Added WSXREG_DCDNAME for the DCD Dll name. It will + *! live under WSXREG_WINSPOXCONFIG. + *! 17-Jul-2000 rr: REG_MGR_OBJECT and REG_DRV_OBJECT defined. They + *! are stored in the Registrty under WSXREG_WINSPOXCONFIG + *! when they are created in DSP_Init. WSXREG_DEVOBJECT + *! and WSXREG_MGROBJECT defined. + *! 11-Dec-1999 ag: Renamed Isa to IsaBus due to conflict with ceddk.h. + *! 12-Nov-1999 rr: New Registry Defnitions. + *! 15-Oct-1999 rr: New entry for DevObject created. WSXREG_DEVOBJECT + *! under WSXREG_DDSPDRIVERPATH + *! 10-Nov-1997 cr: Added WSXREG_INFPATH, WSXREG_WINDEVICEPATH, + *! WSXREG_WINCURVERSION + *! 21-Oct-1997 cr: Added WSXREG_BUSTYPE. + *! 08-Sep-1997 cr: Added WSXREG_SERVICES, WSXREG_SERVICENAME and + *! WSXREG_CLASSINDEX. + *! 30-Aug-1997 cr: Added WSXREG_SOFTWAREPATHNT & WSXREG_WBCLASSGUID. + *! 24-Mar-1997 gp: Added MAXCHIPINFOSUBKEY def. + *! 18-Feb-1997 cr: Changed Version1.1 -> Version1.0 + *! 12-Feb-1997 cr: Changed WinSPOX -> WinBRIDGE. + *! 11-Dec-1996 gp: Added Perf key name in WinSPOX Config. + *! 22-Jul-1996 gp: Added Trace key name. + *! 30-May-1996 cr: Created. + */ + +#ifndef DBREG_ +#define DBREG_ 1 /* Defined as "1" so InstallShield programs compile. */ + +#define REG_MGR_OBJECT 1 +#define REG_DRV_OBJECT 2 +/* general registry definitions */ +#define MAXREGPATHLENGTH 255 /* Max registry path length. Also the + max registry value length. */ +#define DSPTYPE_55 6 /* This is the DSP Chip type for 55 */ +#define DSPTYPE_64 0x99 +#define IVA_ARM7 0x97 /* This is the DSP Chip type for IVA/ARM7 */ + +#define DSPPROCTYPE_C55 5510 +#define DSPPROCTYPE_C64 6410 +#define IVAPROCTYPE_ARM7 470 +/* registry */ +#define DEVNODESTRING "DevNode" /* u32 devnode */ +#define CONFIG "Software\\TexasInstruments\\DirectDSP\\Config" +#define DRVOBJECT "DrvObject" +#define MGROBJECT "MgrObject" +#define CLASS "Device" /* device class */ +#define TRACE "Trace" /* GT Trace settings. */ +#define PERFR "Perf" /* Enable perf bool. */ +#define ROOT "Root" /* root dir */ + +/* MiniDriver related definitions */ +/* The following definitions are under "Drivers\\DirectDSP\\Device\\XXX " + * Where XXX is the device or board name */ + +#define WMDFILENAME "MiniDriver" /* WMD entry name */ +#define CHIPTYPE "ChipType" /* Chip type */ +#define CHIPNUM "NumChips" /* Number of chips */ +#define NUMPROCS "NumOfProcessors" /* Number of processors */ +#define DEFEXEC "DefaultExecutable" /* Default executable */ +#define AUTOSTART "AutoStart" /* Statically load flag */ +#define IVAAUTOSTART "IvaAutoStart" /* Statically load flag */ +#define BOARDNAME "BoardName" /* Name of the Board */ +#define UNITNUMBER "UnitNumber" /* Unit # of the Board */ +#define BUSTYPE "BusType" /* Bus type board is on */ +#define BUSNUMBER "BusNumber" /* Bus number board is on */ +#define CURRENTCONFIG "CurrentConfig" /* Current resources */ +#define PCIVENDEVID "VendorDeviceId" /* The board's id */ +#define INFPATH "InfPath" /* wmd's inf filename */ +#define DEVOBJECT "DevObject" +#define ZLFILENAME "ZLFileName" /* Name of ZL file */ +#define WORDSIZE "WordSize" /* NumBytes in DSP Word */ +#define SHMSIZE "SHMSize" /* Size of SHM reservd on MPU */ +#define IVAEXTMEMSIZE "IVAEXTMEMSize" /* IVA External Memeory size */ +#define TCWORDSWAP "TCWordSwap" /* Traffic Contoller Word Swap */ +#define DSPRESOURCES "DspTMSResources" /* C55 DSP resurces on OMAP */ +#define IVA1RESOURCES "ARM7IvaResources" /* ARM7 IVA resurces on OMAP */ +#define PHYSMEMPOOLBASE "PhysicalMemBase" /* Physical mem passed to driver */ +#define PHYSMEMPOOLSIZE "PhysicalMemSize" /* Physical mem passed to driver */ + +#endif /* DBREG_ */ diff --git a/arch/arm/plat-omap/include/bridge/dbtype.h b/arch/arm/plat-omap/include/bridge/dbtype.h new file mode 100644 index 0000000..7d72653 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dbtype.h @@ -0,0 +1,105 @@ +/* + * arch/arm/plat-omap/include/bridge/dbtype.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== dbtype.h ======== + * Description: + * This header defines data types for DSP/BIOS Bridge APIs and device + * driver modules. It also defines the Hungarian + * prefix to use for each base type. + * + * + *! Revision History: + *! ================= + *! 23-Nov-2002 gp: Purpose -> Description in file header. + *! 13-Feb-2001 kc: Name changed from ddsptype.h dbtype.h. + *! 09-Oct-2000 jeh Added CHARACTER. + *! 11-Aug-2000 ag: Added 'typedef void void'. + *! 08-Apr-2000 ww: Cloned. + */ + +#ifndef DBTYPE_ +#define DBTYPE_ + +/*============================================================================*/ +/* Argument specification syntax */ +/*============================================================================*/ + +#ifndef IN +#define IN /* Following parameter is for input. */ +#endif + +#ifndef OUT +#define OUT /* Following parameter is for output. */ +#endif + +#ifndef OPTIONAL +#define OPTIONAL /* Function may optionally use previous parameter. */ +#endif + +#ifndef CONST +#define CONST const +#endif + +/*============================================================================*/ +/* Boolean constants */ +/*============================================================================*/ + +#ifndef FALSE +#define FALSE 0 +#endif +#ifndef TRUE +#define TRUE 1 +#endif + +/*============================================================================*/ +/* NULL (Definition is language specific) */ +/*============================================================================*/ + +#ifndef NULL +#define NULL ((void *)0) /* Null pointer. */ +#endif + +/*============================================================================*/ +/* NULL character (normally used for string termination) */ +/*============================================================================*/ + +#ifndef NULL_CHAR +#define NULL_CHAR '\0' /* Null character. */ +#endif + +/*============================================================================*/ +/* Basic Type definitions (with Prefixes for Hungarian notation) */ +/*============================================================================*/ + +#ifndef OMAPBRIDGE_TYPES +#define OMAPBRIDGE_TYPES +typedef volatile unsigned short REG_UWORD16; +#endif + +typedef void *HANDLE; /* h */ + +#define TEXT(x) x + +#define CDECL + +#define DLLIMPORT +#define DLLEXPORT + +/* Define DSPAPIDLL correctly in dspapi.h */ +#define _DSPSYSDLL32_ + +#endif /* DBTYPE_ */ diff --git a/arch/arm/plat-omap/include/bridge/ddma_sh.h b/arch/arm/plat-omap/include/bridge/ddma_sh.h new file mode 100644 index 0000000..2cfbe08 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/ddma_sh.h @@ -0,0 +1,95 @@ +/* + * arch/arm/plat-omap/include/bridge/ddma_sh.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== ddma_sh.h ======== + * + * DSP/BIOS Bridge DSP-DMA(DDMA) shared definitions. + * (used on both GPP and DSP sides). + * + * + *! Revision History + *! ================ + *! 12-Jan-2001 ag Added Zero-copy channel descriptor + *! and #ifdef CHNL_DDMA for GPP-side build. + *! 05-Jan-2002 ag Made chnl buf desc ndxs private. + *! 07-Dec-2001 ag DDMA_DSPDESCDONE value changed. + *! 24-Jan-2001 ag Initial. + */ + +#ifndef DDMA_SH_ +#define DDMA_SH_ + +#include + +/* Max # of DDSP DMA channels allowed */ +#define DDMA_MAXZCPYCHNLS 16 +#define DDMA_MAXDDMACHNLS 16 + +/* descriptor status */ +#define DDMA_SOK 0x0 /* transfer ok */ +#define DDMA_SCANCELED 0x1 /* I/O request canceled */ +#define DDMA_SBUFMISMATCH 0x2 /* Src Buf larger than dst. Data clipped */ + +/* descriptor errors */ +#define DDMA_ERRDMA 0x8000 /* DMA error(s) occured */ +#define DDMA_ERRILLDESC 0x800 /* Illegal desc format */ +#define DDMA_ERRTIMEOUT 0x400 /* DMA timeout occured on this descriptor */ +#define DDMA_ERRALIGN 0x200 /* Bad SM buffer alignment */ + +/* cmd codes (workReq field)*/ +#define DDMA_WORKREQ 1 /* Channel work requested by Gpp */ +#define DDMA_WORKREQCLEAR 2 /* Work requested Cleared by Dsp */ +#define DDMA_DSPDESCDONE 2 /* DSP completed DDMA descr proc'ing */ + +/* + * DSP-DMA GPP<->DSP structures + */ + +/* SM buffer descriptor structure */ +struct DDMA_BUFDESC { + DDMA_DWORD workReq; /* Requesting work(DSP-DMA) to be performed */ + DDMA_DWORD status; /* Desc completion status */ + DDMA_DWORD bufPaDsp; /* DSP address of SM buffer. */ + DDMA_DWORD xferSize; /* Size of transfer request in Gpp bytes */ + DDMA_DWORD bufArg; /* Optional argument associated with buffer */ +} ; + +/* bridge channel descriptor ctrl */ +struct DDMA_CHNLDESC { + DDMA_WORD numBufDesc; /* # of SM buf descriptors for this channel */ + DDMA_DWORD descPaDsp; /* DSP address of base SM descriptor. */ +} ; + +/* + * Zero-copy channel descriptor(SM buffer swap) + */ +struct DDMA_ZCPYCHNLDESC { + /* DSP-Side */ + DDMA_DWORD inBuf; /* address of input buffer */ + DDMA_DWORD inDataSize; /* Data size of inBuf (DSP MAUs) */ + DDMA_DWORD inBufSize; /* Actual buffer size of inBuf (DSP MAUs) */ + DDMA_DWORD inUserArg; /* Optional in user argument */ + + DDMA_DWORD outBuf; /* address of output buffer */ + DDMA_DWORD outDataSize; /* Data size of outBuf (DSP MAUs) */ + DDMA_DWORD outBufSize; /* Actual buffer size of outBuf (DSP MAUs) */ + DDMA_DWORD outUserArg; /* Optional out user argument */ + } ; + +#endif /* DDMA_SH_ */ + diff --git a/arch/arm/plat-omap/include/bridge/ddmatypes.h b/arch/arm/plat-omap/include/bridge/ddmatypes.h new file mode 100644 index 0000000..40341f4 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/ddmatypes.h @@ -0,0 +1,36 @@ +/* + * arch/arm/plat-omap/include/bridge/ddmatypes.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== ddmatypes.h ======== + * Description: + * DSP/BIOS Bridge DSP-DMA(DDMA) shared data type definitions. + * + *! Revision History + *! ================ + *! 24-Jan-2001 ag Initial. + */ + +#ifndef DDMATYPES_ +#define DDMATYPES_ + +/* DSP-side definitions */ +typedef u32 DDMA_DWORD; +typedef u32 DDMA_WORD; +typedef u32 DDMA_STATUS; + +#endif /* DDMATYPES_ */ diff --git a/arch/arm/plat-omap/include/bridge/dehdefs.h b/arch/arm/plat-omap/include/bridge/dehdefs.h new file mode 100644 index 0000000..6448337 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dehdefs.h @@ -0,0 +1,42 @@ +/* + * arch/arm/plat-omap/include/bridge/dehdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== dehdefs.h ======== + * Purpose: + * Definition for mini-driver module DEH. + * + *! Revision History: + *! ================ + *! 17-Dec-2001 ag: added #include for shared mailbox codes. + *! 10-Dec-2001 kc: added DEH error base value and error max value. + *! 11-Sep-2001 kc: created. + */ + +#ifndef DEHDEFS_ +#define DEHDEFS_ + +#include /* shared mailbox codes */ + +/* DEH object manager */ + struct DEH_MGR; + +/* Magic code used to determine if DSP signaled exception. */ +#define DEH_BASE MBX_DEH_BASE +#define DEH_USERS_BASE MBX_DEH_USERS_BASE +#define DEH_LIMIT MBX_DEH_LIMIT + +#endif /* _DEHDEFS_H */ diff --git a/arch/arm/plat-omap/include/bridge/dev.h b/arch/arm/plat-omap/include/bridge/dev.h new file mode 100644 index 0000000..455db65 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dev.h @@ -0,0 +1,804 @@ +/* + * arch/arm/plat-omap/include/bridge/dev.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dev.h ======== + * Description: + * 'Bridge Mini-driver device operations. + * + * Public Functions: + * DEV_BrdWriteFxn + * DEV_CreateDevice + * DEV_Create2 + * DEV_Destroy2 + * DEV_DestroyDevice + * DEV_GetChnlMgr + * DEV_GetCmmMgr + * DEV_GetCodMgr + * DEV_GetDehMgr + * DEV_GetDevNode + * DEV_GetDSPWordSize + * DEV_GetFirst + * DEV_GetIntfFxns + * DEV_GetIOMgr + * DEV_GetMsgMgr + * DEV_GetNext + * DEV_GetNodeManager + * DEV_GetSymbol + * DEV_GetWMDContext + * DEV_Exit + * DEV_Init + * DEV_InsertProcObject + * DEV_IsLocked + * DEV_NotifyClient + * DEV_RegisterNotify + * DEV_ReleaseCodMgr + * DEV_RemoveDevice + * DEV_RemoveProcObject + * DEV_SetChnlMgr + * DEV_SetMsgMgr + * DEV_SetLockOwner + * DEV_StartDevice + * + *! Revision History: + *! ================ + *! 08-Mar-2004 sb Added the Dynamic Memory Mapping feature - Dev_GetDmmMgr + *! 09-Feb-2004 vp Added functions required for IVA + *! 25-Feb-2003 swa PMGR Code Review changes incorporated + *! 05-Nov-2001 kc: Added DEV_GetDehMgr. + *! 05-Dec-2000 jeh Added DEV_SetMsgMgr. + *! 29-Nov-2000 rr: Incorporated code review changes. + *! 17-Nov-2000 jeh Added DEV_GetMsgMgr. + *! 05-Oct-2000 rr: DEV_Create2 & DEV_Destroy2 Added. + *! 02-Oct-2000 rr: Added DEV_GetNodeManager. + *! 11-Aug-2000 ag: Added DEV_GetCmmMgr() for shared memory management. + *! 10-Aug-2000 rr: DEV_InsertProcObject/RemoveProcObject added. + *! 06-Jun-2000 jeh Added DEV_GetSymbol(). + *! 05-Nov-1999 kc: Updated function prototypes. + *! 08-Oct-1997 cr: Added explicit CDECL function identifiers. + *! 07-Nov-1996 gp: Updated for code review. + *! 22-Oct-1996 gp: Added DEV_CleanupProcessState(). + *! 29-May-1996 gp: Changed DEV_HDEVNODE --> CFG_HDEVNODE. + *! 18-May-1996 gp: Created. + */ + +#ifndef DEV_ +#define DEV_ + +/* ----------------------------------- Module Dependent Headers */ +#include +#include +#include +#include +#include +#include +#include +#include +#include + +/* ----------------------------------- This */ +#include + +/* Notification callback for DEV clients BRD and CHNL */ + typedef void(CDECL *DEV_CALLBACK) (void *pArb, u32 ulStatus); + +/* + * ======== DEV_BrdWriteFxn ======== + * Purpose: + * Exported function to be used as the COD write function. This function + * is passed a handle to a DEV_hObject by ZL in pArb, then calls the + * device's WMD_BRD_Write() function. + * Parameters: + * pArb: Handle to a Device Object. + * hDevContext: Handle to mini-driver defined device info. + * dwDSPAddr: Address on DSP board (Destination). + * pHostBuf: Pointer to host buffer (Source). + * ulNumBytes: Number of bytes to transfer. + * ulMemType: Memory space on DSP to which to transfer. + * Returns: + * Number of bytes written. Returns 0 if the DEV_hObject passed in via + * pArb is invalid. + * Requires: + * DEV Initialized. + * pHostBuf != NULL + * Ensures: + */ + extern u32 CDECL DEV_BrdWriteFxn(void *pArb, + u32 ulDspAddr, + void *pHostBuf, + u32 ulNumBytes, u32 nMemSpace); + +/* + * ======== DEV_CreateDevice ======== + * Purpose: + * Called by the operating system to load the 'Bridge Mini Driver for a + * 'Bridge device. + * Parameters: + * phDevObject: Ptr to location to receive the device object handle. + * pstrWMDFileName: Name of WMD PE DLL file to load. If the absolute + * path is not provided, the file is loaded through + * 'Bridge's module search path. + * pHostConfig: Host configuration information, to be passed down + * to the WMD when WMD_DEV_Create() is called. + * pDspConfig: DSP resources, to be passed down to the WMD when + * WMD_DEV_Create() is called. + * hDevNode: Platform (Windows) specific device node. + * Returns: + * DSP_SOK: Module is loaded, device object has been created + * DSP_EMEMORY: Insufficient memory to create needed resources. + * DEV_E_NEWWMD: The WMD was compiled for a newer version of WCD. + * DEV_E_NULLWMDINTF: WMD passed back a NULL Fxn Interface Struct Ptr + * DEV_E_NOCODMODULE: No ZL file name was specified in the registry + * for this hDevNode. + * LDR_E_FILEUNABLETOOPEN: Unable to open the specified WMD. + * LDR_E_NOMEMORY: PELDR is out of resources. + * DSP_EFAIL: Unable to find WMD entry point function. + * COD_E_NOZLFUNCTIONS: One or more ZL functions exports not found. + * COD_E_ZLCREATEFAILED: Unable to load ZL DLL. + * Requires: + * DEV Initialized. + * phDevObject != NULL. + * pstrWMDFileName != NULL. + * pHostConfig != NULL. + * pDspConfig != NULL. + * Ensures: + * DSP_SOK: *phDevObject will contain handle to the new device object. + * Otherwise, does not create the device object, ensures the WMD module is + * unloaded, and sets *phDevObject to NULL. + */ + extern DSP_STATUS CDECL DEV_CreateDevice(OUT struct DEV_OBJECT + **phDevObject, + IN CONST char *pstrWMDFileName, + IN CONST struct CFG_HOSTRES + *pHostConfig, + IN CONST struct CFG_DSPRES + *pDspConfig, + struct CFG_DEVNODE *hDevNode); + +/* + * ======== DEV_CreateIVADevice ======== + * Purpose: + * Called by the operating system to load the 'Bridge Mini Driver for IVA. + * Parameters: + * phDevObject: Ptr to location to receive the device object handle. + * pstrWMDFileName: Name of WMD PE DLL file to load. If the absolute + * path is not provided, the file is loaded through + * 'Bridge's module search path. + * pHostConfig: Host configuration information, to be passed down + * to the WMD when WMD_DEV_Create() is called. + * pDspConfig: DSP resources, to be passed down to the WMD when + * WMD_DEV_Create() is called. + * hDevNode: Platform (Windows) specific device node. + * Returns: + * DSP_SOK: Module is loaded, device object has been created + * DSP_EMEMORY: Insufficient memory to create needed resources. + * DEV_E_NEWWMD: The WMD was compiled for a newer version of WCD. + * DEV_E_NULLWMDINTF: WMD passed back a NULL Fxn Interface Struct Ptr + * DEV_E_NOCODMODULE: No ZL file name was specified in the registry + * for this hDevNode. + * LDR_E_FILEUNABLETOOPEN: Unable to open the specified WMD. + * LDR_E_NOMEMORY: PELDR is out of resources. + * DSP_EFAIL: Unable to find WMD entry point function. + * COD_E_NOZLFUNCTIONS: One or more ZL functions exports not found. + * COD_E_ZLCREATEFAILED: Unable to load ZL DLL. + * Requires: + * DEV Initialized. + * phDevObject != NULL. + * pstrWMDFileName != NULL. + * pHostConfig != NULL. + * pDspConfig != NULL. + * Ensures: + * DSP_SOK: *phDevObject will contain handle to the new device object. + * Otherwise, does not create the device object, ensures the WMD module is + * unloaded, and sets *phDevObject to NULL. + */ + extern DSP_STATUS CDECL DEV_CreateIVADevice(OUT struct DEV_OBJECT + **phDevObject, + IN CONST char *pstrWMDFileName, + IN CONST struct CFG_HOSTRES *pHostConfig, + IN CONST struct CFG_DSPRES *pDspConfig, + struct CFG_DEVNODE *hDevNode); + +/* + * ======== DEV_Create2 ======== + * Purpose: + * After successful loading of the image from WCD_InitComplete2 + * (PROC Auto_Start) or PROC_Load this fxn is called. This creates + * the Node Manager and updates the DEV Object. + * Parameters: + * hDevObject: Handle to device object created with DEV_CreateDevice(). + * Returns: + * DSP_SOK: Successful Creation of Node Manager + * DSP_EFAIL: Some Error Occurred. + * Requires: + * DEV Initialized + * Valid hDevObject + * Ensures: + * DSP_SOK and hDevObject->hNodeMgr != NULL + * else hDevObject->hNodeMgr == NULL + */ + extern DSP_STATUS CDECL DEV_Create2(IN struct DEV_OBJECT *hDevObject); + +/* + * ======== DEV_Destroy2 ======== + * Purpose: + * Destroys the Node manager for this device. + * Parameters: + * hDevObject: Handle to device object created with DEV_CreateDevice(). + * Returns: + * DSP_SOK: Successful Creation of Node Manager + * DSP_EFAIL: Some Error Occurred. + * Requires: + * DEV Initialized + * Valid hDevObject + * Ensures: + * DSP_SOK and hDevObject->hNodeMgr == NULL + * else DSP_EFAIL. + */ + extern DSP_STATUS CDECL DEV_Destroy2(IN struct DEV_OBJECT *hDevObject); + +/* + * ======== DEV_DestroyDevice ======== + * Purpose: + * Destroys the channel manager for this device, if any, calls + * WMD_DEV_Destroy(), and then attempts to unload the WMD module. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * DSP_EFAIL: The WMD failed it's WMD_DEV_Destroy() function. + * Requires: + * DEV Initialized. + * Ensures: + */ + extern DSP_STATUS CDECL DEV_DestroyDevice(struct DEV_OBJECT + *hDevObject); + +/* + * ======== DEV_GetChnlMgr ======== + * Purpose: + * Retrieve the handle to the channel manager created for this device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * *phMgr: Ptr to location to store handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phMgr != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phMgr contains a handle to a channel manager object, + * or NULL. + * else: *phMgr is NULL. + */ + extern DSP_STATUS CDECL DEV_GetChnlMgr(struct DEV_OBJECT *hDevObject, + OUT struct CHNL_MGR **phMgr); + +/* + * ======== DEV_GetCmmMgr ======== + * Purpose: + * Retrieve the handle to the shared memory manager created for this + * device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * *phMgr: Ptr to location to store handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phMgr != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phMgr contains a handle to a channel manager object, + * or NULL. + * else: *phMgr is NULL. + */ + extern DSP_STATUS CDECL DEV_GetCmmMgr(struct DEV_OBJECT *hDevObject, + OUT struct CMM_OBJECT **phMgr); + +/* + * ======== DEV_GetDmmMgr ======== + * Purpose: + * Retrieve the handle to the dynamic memory manager created for this + * device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * *phMgr: Ptr to location to store handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phMgr != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phMgr contains a handle to a channel manager object, + * or NULL. + * else: *phMgr is NULL. + */ + extern DSP_STATUS CDECL DEV_GetDmmMgr(struct DEV_OBJECT *hDevObject, + OUT struct DMM_OBJECT **phMgr); + +/* + * ======== DEV_GetCodMgr ======== + * Purpose: + * Retrieve the COD manager create for this device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * *phCodMgr: Ptr to location to store handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phCodMgr != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phCodMgr contains a handle to a COD manager object. + * else: *phCodMgr is NULL. + */ + extern DSP_STATUS CDECL DEV_GetCodMgr(struct DEV_OBJECT *hDevObject, + OUT struct COD_MANAGER **phCodMgr); + +/* + * ======== DEV_GetDehMgr ======== + * Purpose: + * Retrieve the DEH manager created for this device. + * Parameters: + * hDevObject: Handle to device object created with DEV_CreateDevice(). + * *phDehMgr: Ptr to location to store handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phDehMgr != NULL. + * DEH Initialized. + * Ensures: + * DSP_SOK: *phDehMgr contains a handle to a DEH manager object. + * else: *phDehMgr is NULL. + */ + extern DSP_STATUS CDECL DEV_GetDehMgr(struct DEV_OBJECT *hDevObject, + OUT struct DEH_MGR **phDehMgr); + +/* + * ======== DEV_GetDevNode ======== + * Purpose: + * Retrieve the platform specific device ID for this device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * phDevNode: Ptr to location to get the device node handle. + * Returns: + * DSP_SOK: In Win95, returns a DEVNODE in *hDevNode; In NT, ??? + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phDevNode != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phDevNode contains a platform specific device ID; + * else: *phDevNode is NULL. + */ + extern DSP_STATUS CDECL DEV_GetDevNode(struct DEV_OBJECT *hDevObject, + OUT struct CFG_DEVNODE **phDevNode); + +/* + * ======== DEV_GetDevType ======== + * Purpose: + * Retrieve the platform specific device ID for this device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * phDevNode: Ptr to location to get the device node handle. + * Returns: + * DSP_SOK: Success + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phDevNode != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phDevNode contains a platform specific device ID; + * else: *phDevNode is NULL. + */ + extern DSP_STATUS CDECL DEV_GetDevType(struct DEV_OBJECT *hdevObject, + u32 *devType); + +/* + * ======== DEV_GetFirst ======== + * Purpose: + * Retrieve the first Device Object handle from an internal linked list of + * of DEV_OBJECTs maintained by DEV. + * Parameters: + * Returns: + * NULL if there are no device objects stored; else + * a valid DEV_HOBJECT. + * Requires: + * No calls to DEV_CreateDevice or DEV_DestroyDevice (which my modify the + * internal device object list) may occur between calls to DEV_GetFirst + * and DEV_GetNext. + * Ensures: + * The DEV_HOBJECT returned is valid. + * A subsequent call to DEV_GetNext will return the next device object in + * the list. + */ + extern struct DEV_OBJECT *CDECL DEV_GetFirst(); + +/* + * ======== DEV_GetIntfFxns ======== + * Purpose: + * Retrieve the WMD interface function structure for the loaded WMD. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * *ppIntfFxns: Ptr to location to store fxn interface. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * ppIntfFxns != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *ppIntfFxns contains a pointer to the WMD interface; + * else: *ppIntfFxns is NULL. + */ + extern DSP_STATUS CDECL DEV_GetIntfFxns(struct DEV_OBJECT *hDevObject, + OUT struct WMD_DRV_INTERFACE **ppIntfFxns); + +/* + * ======== DEV_GetIOMgr ======== + * Purpose: + * Retrieve the handle to the IO manager created for this device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * *phMgr: Ptr to location to store handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phMgr != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phMgr contains a handle to an IO manager object. + * else: *phMgr is NULL. + */ + extern DSP_STATUS CDECL DEV_GetIOMgr(struct DEV_OBJECT *hDevObject, + OUT struct IO_MGR **phMgr); + +/* + * ======== DEV_GetNext ======== + * Purpose: + * Retrieve the next Device Object handle from an internal linked list of + * of DEV_OBJECTs maintained by DEV, after having previously called + * DEV_GetFirst() and zero or more DEV_GetNext + * Parameters: + * hDevObject: Handle to the device object returned from a previous + * call to DEV_GetFirst() or DEV_GetNext(). + * Returns: + * NULL if there are no further device objects on the list or hDevObject + * was invalid; + * else the next valid DEV_HOBJECT in the list. + * Requires: + * No calls to DEV_CreateDevice or DEV_DestroyDevice (which my modify the + * internal device object list) may occur between calls to DEV_GetFirst + * and DEV_GetNext. + * Ensures: + * The DEV_HOBJECT returned is valid. + * A subsequent call to DEV_GetNext will return the next device object in + * the list. + */ + extern struct DEV_OBJECT *CDECL DEV_GetNext(struct DEV_OBJECT + *hDevObject); + +/* + * ========= DEV_GetMsgMgr ======== + * Purpose: + * Retrieve the MSG Manager Handle from the DevObject. + * Parameters: + * hDevObject: Handle to the Dev Object + * phMsgMgr: Location where MSG Manager handle will be returned. + * Returns: + * Requires: + * DEV Initialized. + * Valid hDevObject. + * phNodeMgr != NULL. + * Ensures: + */ + extern void CDECL DEV_GetMsgMgr(struct DEV_OBJECT *hDevObject, + OUT struct MSG_MGR **phMsgMgr); + +/* + * ========= DEV_GetNodeManager ======== + * Purpose: + * Retrieve the Node Manager Handle from the DevObject. It is an + * accessor function + * Parameters: + * hDevObject: Handle to the Dev Object + * phNodeMgr: Location where Handle to the Node Manager will be + * returned.. + * Returns: + * DSP_SOK: Success + * DSP_EHANDLE: Invalid Dev Object handle. + * Requires: + * DEV Initialized. + * phNodeMgr is not null + * Ensures: + * DSP_SOK: *phNodeMgr contains a handle to a Node manager object. + * else: *phNodeMgr is NULL. + */ + extern DSP_STATUS CDECL DEV_GetNodeManager(struct DEV_OBJECT + *hDevObject, + OUT struct NODE_MGR **phNodeMgr); + +/* + * ======== DEV_GetSymbol ======== + * Purpose: + * Get the value of a symbol in the currently loaded program. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * pstrSym: Name of symbol to look up. + * pulValue: Ptr to symbol value. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * COD_E_NOSYMBOLSLOADED: Symbols have not been loaded onto the board. + * COD_E_SYMBOLNOTFOUND: The symbol could not be found. + * Requires: + * pstrSym != NULL. + * pulValue != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *pulValue contains the symbol value; + */ + extern DSP_STATUS CDECL DEV_GetSymbol(struct DEV_OBJECT *hDevObject, + IN CONST char *pstrSym, + OUT u32 *pulValue); + +/* + * ======== DEV_GetWMDContext ======== + * Purpose: + * Retrieve the WMD Context handle, as returned by the WMD_Create fxn. + * Parameters: + * hDevObject: Handle to device object created with DEV_CreateDevice() + * *phWmdContext: Ptr to location to store context handle. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * phWmdContext != NULL. + * DEV Initialized. + * Ensures: + * DSP_SOK: *phWmdContext contains context handle; + * else: *phWmdContext is NULL; + */ + extern DSP_STATUS CDECL DEV_GetWMDContext(struct DEV_OBJECT *hDevObject, + OUT struct WMD_DEV_CONTEXT **phWmdContext); + +/* + * ======== DEV_Exit ======== + * Purpose: + * Decrement reference count, and free resources when reference count is + * 0. + * Parameters: + * Returns: + * Requires: + * DEV is initialized. + * Ensures: + * When reference count == 0, DEV's private resources are freed. + */ + extern void CDECL DEV_Exit(); + +/* + * ======== DEV_Init ======== + * Purpose: + * Initialize DEV's private state, keeping a reference count on each call. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * TRUE: A requirement for the other public DEV functions. + */ + extern bool CDECL DEV_Init(); + +/* + * ======== DEV_IsLocked ======== + * Purpose: + * Predicate function to determine if the device has been + * locked by a client for exclusive access. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * Returns: + * DSP_SOK: TRUE: device has been locked. + * DSP_SFALSE: FALSE: device not locked. + * DSP_EHANDLE: hDevObject was invalid. + * Requires: + * DEV Initialized. + * Ensures: + */ + extern DSP_STATUS CDECL DEV_IsLocked(IN struct DEV_OBJECT *hDevObject); + +/* + * ======== DEV_InsertProcObject ======== + * Purpose: + * Inserts the Processor Object into the List of PROC Objects + * kept in the DEV Object + * Parameters: + * hProcObject: Handle to the Proc Object + * hDevObject Handle to the Dev Object + * bAttachedNew Specifies if there are already processors attached + * Returns: + * DSP_SOK: Successfully inserted into the list + * Requires: + * hProcObject is not NULL + * hDevObject is a valid handle to the DEV. + * DEV Initialized. + * List(of Proc object in Dev) Exists. + * Ensures: + * DSP_SOK & the PROC Object is inserted and the list is not empty + * Details: + * If the List of Proc Object is empty bAttachedNew is TRUE, it indicated + * this is the first Processor attaching. + * If it is False, there are already processors attached. + */ + extern DSP_STATUS CDECL DEV_InsertProcObject(IN struct DEV_OBJECT + *hDevObject, + IN u32 hProcObject, + OUT bool * + pbAlreadyAttached); + +/* + * ======== DEV_RemoveProcObject ======== + * Purpose: + * Search for and remove a Proc object from the given list maintained + * by the DEV + * Parameters: + * pProcObject: Ptr to ProcObject to insert. + * pDevObject: Ptr to Dev Object where the list is. + * pbAlreadyAttached: Ptr to return the bool + * Returns: + * DSP_SOK: If successful. + * DSP_EFAIL Failure to Remove the PROC Object from the list + * Requires: + * DevObject is Valid + * hProcObject != 0 + * pDevObject->procList != NULL + * !LST_IsEmpty(pDevObject->procList) + * pbAlreadyAttached !=NULL + * Ensures: + * Details: + * List will be deleted when the DEV is destroyed. + * + */ + extern DSP_STATUS CDECL DEV_RemoveProcObject(struct DEV_OBJECT + *hDevObject, + u32 hProcObject); + +/* + * ======== DEV_NotifyClients ======== + * Purpose: + * Notify all clients of this device of a change in device status. + * Clients may include multiple users of BRD, as well as CHNL. + * This function is asychronous, and may be called by a timer event + * set up by a watchdog timer. + * Parameters: + * hDevObject: Handle to device object created with DEV_CreateDevice(). + * ulStatus: A status word, most likely a BRD_STATUS. + * Returns: + * DSP_SOK: All registered clients were asynchronously notified. + * DSP_EINVALIDARG: Invalid hDevObject. + * Requires: + * DEV Initialized. + * Ensures: + * DSP_SOK: Notifications are queued by the operating system to be + * delivered to clients. This function does not ensure that + * the notifications will ever be delivered. + */ + extern DSP_STATUS CDECL DEV_NotifyClients(struct DEV_OBJECT *hDevObject, + u32 ulStatus); + +/* + * ======== DEV_RegisterNotify ======== + * Purpose: + * Register a callback function and callback argument for DEV to call + * when a change in device status occurs. + * Parameters: + * hDevObject: Handle to device object created with DEV_CreateDevice(). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid Dev Object handle. + * Requires: + * DEV Initialized. + * Ensures: + */ + extern DSP_STATUS CDECL DEV_RegisterNotify(struct DEV_OBJECT + *hDevObject, + void *pArb, + DEV_CALLBACK lpCallback); + +/* + * ======== DEV_RemoveDevice ======== + * Purpose: + * Destroys the Device Object created by DEV_StartDevice. + * Parameters: + * hDevNode: Device node as it is know to OS. + * Returns: + * DSP_SOK: If success; + * Otherwise. + * Requires: + * Ensures: + */ + extern DSP_STATUS CDECL DEV_RemoveDevice(struct CFG_DEVNODE *hDevNode); + +/* + * ======== DEV_SetChnlMgr ======== + * Purpose: + * Set the channel manager for this device. + * Parameters: + * hDevObject: Handle to device object created with + * DEV_CreateDevice(). + * hMgr: Handle to a channel manager, or NULL. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDevObject. + * Requires: + * DEV Initialized. + * Ensures: + */ + extern DSP_STATUS CDECL DEV_SetChnlMgr(struct DEV_OBJECT *hDevObject, + struct CHNL_MGR *hMgr); + +/* + * ======== DEV_SetMsgMgr ======== + * Purpose: + * Set the Message manager for this device. + * Parameters: + * hDevObject: Handle to device object created with DEV_CreateDevice(). + * hMgr: Handle to a message manager, or NULL. + * Returns: + * Requires: + * DEV Initialized. + * Ensures: + */ + extern void CDECL DEV_SetMsgMgr(struct DEV_OBJECT *hDevObject, + struct MSG_MGR *hMgr); + +/* + * ======== DEV_StartDevice ======== + * Purpose: + * Initializes the new device with the WinBRIDGE environment. This + * involves querying CM for allocated resources, querying the registry + * for necessary dsp resources (requested in the INF file), and using + * this information to create a WinBRIDGE device object. + * Parameters: + * hDevNode: Device node as it is know to OS. + * Returns: + * DSP_SOK: If success; + * Otherwise. + * Requires: + * DEV initialized. + * Ensures: + */ + extern DSP_STATUS CDECL DEV_StartDevice(struct CFG_DEVNODE *hDevNode); + +#endif /* DEV_ */ diff --git a/arch/arm/plat-omap/include/bridge/devdefs.h b/arch/arm/plat-omap/include/bridge/devdefs.h new file mode 100644 index 0000000..eea6185 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/devdefs.h @@ -0,0 +1,35 @@ +/* + * arch/arm/plat-omap/include/bridge/devdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== devdefs.h ======== + * Purpose: + * Definition of common include typedef between wmd.h and dev.h. Required + * to break circular dependency between WMD and DEV include files. + * + *! Revision History: + *! ================ + *! 12-Nov-1996 gp: Renamed from dev1.h. + *! 30-May-1996 gp: Broke out from dev.h + */ + +#ifndef DEVDEFS_ +#define DEVDEFS_ + +/* WCD Device Object */ + struct DEV_OBJECT; + +#endif /* DEVDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/disp.h b/arch/arm/plat-omap/include/bridge/disp.h new file mode 100644 index 0000000..608ef9d --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/disp.h @@ -0,0 +1,236 @@ +/* + * arch/arm/plat-omap/include/bridge/disp.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== disp.h ======== + * + * Description: + * DSP/BIOS Bridge Node Dispatcher. + * + * Public Functions: + * DISP_Create + * DISP_Delete + * DISP_Exit + * DISP_Init + * DISP_NodeChangePriority + * DISP_NodeCreate + * DISP_NodeDelete + * DISP_NodeRun + * + *! Revision History: + *! ================= + *! 28-Jan-2003 map Removed DISP_DoCinit(). + *! 15-May-2002 jeh Added DISP_DoCinit(). + *! 24-Apr-2002 jeh Added DISP_MemWrite(). + *! 07-Sep-2001 jeh Added DISP_MemCopy(). + *! 10-May-2001 jeh Code review cleanup. + *! 08-Aug-2000 jeh Removed DISP_NodeTerminate since it no longer uses RMS. + *! 17-Jul-2000 jeh Updates to function headers. + *! 19-Jun-2000 jeh Created. + */ + +#ifndef DISP_ +#define DISP_ + +#include +#include +#include +#include + +/* + * ======== DISP_Create ======== + * Create a NODE Dispatcher object. This object handles the creation, + * deletion, and execution of nodes on the DSP target, through communication + * with the Resource Manager Server running on the target. Each NODE + * Manager object should have exactly one NODE Dispatcher. + * + * Parameters: + * phDispObject: Location to store node dispatcher object on output. + * hDevObject: Device for this processor. + * pDispAttrs: Node dispatcher attributes. + * Returns: + * DSP_SOK: Success; + * DSP_EMEMORY: Insufficient memory for requested resources. + * DSP_EFAIL: Unable to create dispatcher. + * Requires: + * DISP_Init() called. + * pDispAttrs != NULL. + * hDevObject != NULL. + * phDispObject != NULL. + * Ensures: + * DSP_SOK: IsValid(*phDispObject). + * error: *phDispObject == NULL. + */ + extern DSP_STATUS DISP_Create(OUT struct DISP_OBJECT **phDispObject, + struct DEV_OBJECT *hDevObject, + IN CONST struct DISP_ATTRS *pDispAttrs); + +/* + * ======== DISP_Delete ======== + * Delete the NODE Dispatcher. + * + * Parameters: + * hDispObject: Node Dispatcher object. + * Returns: + * Requires: + * DISP_Init() called. + * Valid hDispObject. + * Ensures: + * hDispObject is invalid. + */ + extern void DISP_Delete(struct DISP_OBJECT *hDispObject); + +/* + * ======== DISP_Exit ======== + * Discontinue usage of DISP module. + * + * Parameters: + * Returns: + * Requires: + * DISP_Init() previously called. + * Ensures: + * Any resources acquired in DISP_Init() will be freed when last DISP + * client calls DISP_Exit(). + */ + extern void DISP_Exit(); + +/* + * ======== DISP_Init ======== + * Initialize the DISP module. + * + * Parameters: + * Returns: + * TRUE if initialization succeeded, FALSE otherwise. + * Ensures: + */ + extern bool DISP_Init(); + +/* + * ======== DISP_NodeChangePriority ======== + * Change the priority of a node currently running on the target. + * + * Parameters: + * hDispObject: Node Dispatcher object. + * hNode: Node object representing a node currently + * allocated or running on the DSP. + * ulFxnAddress: Address of RMS function for changing priority. + * nodeEnv: Address of node's environment structure. + * nPriority: New priority level to set node's priority to. + * Returns: + * DSP_SOK: Success. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * Requires: + * DISP_Init() called. + * Valid hDispObject. + * hNode != NULL. + * Ensures: + */ + extern DSP_STATUS DISP_NodeChangePriority(struct DISP_OBJECT + *hDispObject, + struct NODE_OBJECT *hNode, + u32 ulFxnAddr, + NODE_ENV nodeEnv, + s32 nPriority); + +/* + * ======== DISP_NodeCreate ======== + * Create a node on the DSP by remotely calling the node's create function. + * + * Parameters: + * hDispObject: Node Dispatcher object. + * hNode: Node handle obtained from NODE_Allocate(). + * ulFxnAddr: Address or RMS create node function. + * ulCreateFxn: Address of node's create function. + * pArgs: Arguments to pass to RMS node create function. + * pNodeEnv: Location to store node environment pointer on + * output. + * Returns: + * DSP_SOK: Success. + * DSP_ETASK: Unable to create the node's task or process on the DSP. + * DSP_ESTREAM: Stream creation failure on the DSP. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * DSP_EUSER: A user-defined failure occurred. + * DSP_EFAIL: A failure occurred, unable to create node. + * Requires: + * DISP_Init() called. + * Valid hDispObject. + * pArgs != NULL. + * hNode != NULL. + * pNodeEnv != NULL. + * NODE_GetType(hNode) != NODE_DEVICE. + * Ensures: + */ + extern DSP_STATUS DISP_NodeCreate(struct DISP_OBJECT *hDispObject, + struct NODE_OBJECT *hNode, + u32 ulFxnAddr, + u32 ulCreateFxn, + IN CONST struct NODE_CREATEARGS + *pArgs, + OUT NODE_ENV *pNodeEnv); + +/* + * ======== DISP_NodeDelete ======== + * Delete a node on the DSP by remotely calling the node's delete function. + * + * Parameters: + * hDispObject: Node Dispatcher object. + * hNode: Node object representing a node currently + * loaded on the DSP. + * ulFxnAddr: Address or RMS delete node function. + * ulDeleteFxn: Address of node's delete function. + * nodeEnv: Address of node's environment structure. + * Returns: + * DSP_SOK: Success. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * Requires: + * DISP_Init() called. + * Valid hDispObject. + * hNode != NULL. + * Ensures: + */ + extern DSP_STATUS DISP_NodeDelete(struct DISP_OBJECT *hDispObject, + struct NODE_OBJECT *hNode, + u32 ulFxnAddr, + u32 ulDeleteFxn, NODE_ENV nodeEnv); + +/* + * ======== DISP_NodeRun ======== + * Start execution of a node's execute phase, or resume execution of a node + * that has been suspended (via DISP_NodePause()) on the DSP. + * + * Parameters: + * hDispObject: Node Dispatcher object. + * hNode: Node object representing a node to be executed + * on the DSP. + * ulFxnAddr: Address or RMS node execute function. + * ulExecuteFxn: Address of node's execute function. + * nodeEnv: Address of node's environment structure. + * Returns: + * DSP_SOK: Success. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * Requires: + * DISP_Init() called. + * Valid hDispObject. + * hNode != NULL. + * Ensures: + */ + extern DSP_STATUS DISP_NodeRun(struct DISP_OBJECT *hDispObject, + struct NODE_OBJECT *hNode, + u32 ulFxnAddr, + u32 ulExecuteFxn, NODE_ENV nodeEnv); + +#endif /* DISP_ */ diff --git a/arch/arm/plat-omap/include/bridge/dispdefs.h b/arch/arm/plat-omap/include/bridge/dispdefs.h new file mode 100644 index 0000000..6dfdbba --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dispdefs.h @@ -0,0 +1,45 @@ +/* + * arch/arm/plat-omap/include/bridge/dispdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dispdefs.h ======== + * Description: + * Global DISP constants and types, shared by PROCESSOR, NODE, and DISP. + * + *! Revision History + *! ================ + *! 08-Aug-2000 jeh Added fields to DISP_ATTRS. + *! 06-Jul-2000 jeh Created. + */ + +#ifndef DISPDEFS_ +#define DISPDEFS_ + + struct DISP_OBJECT; + +/* Node Dispatcher attributes */ + struct DISP_ATTRS { + u32 ulChnlOffset; /* Offset of channel ids reserved for RMS */ + /* Size of buffer for sending data to RMS */ + u32 ulChnlBufSize; + DSP_PROCFAMILY procFamily; /* eg, 5000 */ + DSP_PROCTYPE procType; /* eg, 5510 */ + HANDLE hReserved1; /* Reserved for future use. */ + u32 hReserved2; /* Reserved for future use. */ + } ; + +#endif /* DISPDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/dldr.h b/arch/arm/plat-omap/include/bridge/dldr.h new file mode 100644 index 0000000..6a21b6f --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dldr.h @@ -0,0 +1,75 @@ +/* + * bridge/inc/dldr.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dldr.h ======== + * + * Description: + * DSP/BIOS Bridge dynamic loader interface. See the file dldrdefs.h + * for a description of these functions. + * + * Public Functions: + * DLDR_Allocate + * DLDR_Create + * DLDR_Delete + * DLDR_Exit + * DLDR_Free + * DLDR_GetFxnAddr + * DLDR_Init + * DLDR_Load + * DLDR_Unload + * + * Notes: + * + *! Revision History + *! ================ + *! 31-Jul-2002 jeh Removed function header comments. + *! 17-Apr-2002 jeh Created. + */ + +#include +#include +#include + +#ifndef DLDR_ +#define DLDR_ + + extern DSP_STATUS DLDR_Allocate(struct DLDR_OBJECT *hDldr, + void *pPrivRef, + IN CONST struct DCD_NODEPROPS + *pNodeProps, + OUT struct DLDR_NODEOBJECT + **phDldrNode); + + extern DSP_STATUS DLDR_Create(OUT struct DLDR_OBJECT **phDldr, + struct DEV_OBJECT *hDevObject, + IN CONST struct DLDR_ATTRS *pAttrs); + + extern void DLDR_Delete(struct DLDR_OBJECT *hDldr); + extern void DLDR_Exit(); + extern void DLDR_Free(struct DLDR_NODEOBJECT *hDldrNode); + + extern DSP_STATUS DLDR_GetFxnAddr(struct DLDR_NODEOBJECT *hDldrNode, + char *pstrFxn, u32 *pulAddr); + + extern bool DLDR_Init(); + extern DSP_STATUS DLDR_Load(struct DLDR_NODEOBJECT *hDldrNode, + enum DLDR_PHASE phase); + extern DSP_STATUS DLDR_Unload(struct DLDR_NODEOBJECT *hDldrNode, + enum DLDR_PHASE phase); + +#endif /* DLDR_ */ diff --git a/arch/arm/plat-omap/include/bridge/dldrdefs.h b/arch/arm/plat-omap/include/bridge/dldrdefs.h new file mode 100644 index 0000000..cf20c14 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dldrdefs.h @@ -0,0 +1,315 @@ +/* + * bridge/inc/dldrdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dldrdefs.h ======== + * + * Description: + * DSP/BIOS Bridge loader interface. This is the interface shared by + * all loaders (eg, static loader and dynamic loader). This interface will + * be used by NODE. + * + *! Revision History + *! ================ + *! 16-Sep-2002 map Updated with code review changes + *! 24-Apr-2002 jeh Added DLDR_WRITEFXN. + *! 05-Nov-2001 jeh Changed some function error return codes. + *! 17-Sep-2001 jeh Added function typedefs. + *! 22-Aug-2001 jeh Created. + */ + +#ifndef DLDRDEFS_ +#define DLDRDEFS_ + +#include +#include + +#define DLDR_MAXPATHLENGTH 255 + +/* DLDR Objects: */ + struct DLDR_OBJECT; + struct DLDR_NODEOBJECT; + +/* + * ======== DLDR_LOADTYPE ======== + * Load types for a node. Must match values in node.h55. + */ + enum DLDR_LOADTYPE { + DLDR_STATICLOAD, /* Linked in base image, not overlay */ + DLDR_DYNAMICLOAD, /* Dynamically loaded node */ + DLDR_OVLYLOAD /* Linked in base image, overlay node */ + } ; + +/* + * ======== DLDR_OVLYFXN ======== + * Causes code or data to be copied from load address to run address. This + * is the "COD_WRITEFXN" that gets passed to the DBL_Library and is used as + * the ZL write function. + * + * Parameters: + * pPrivRef: Handle to identify the node. + * ulDspRunAddr: Run address of code or data. + * ulDspLoadAddr: Load address of code or data. + * ulNumBytes: Number of (GPP) bytes to copy. + * nMemSpace: RMS_CODE or RMS_DATA. + * Returns: + * ulNumBytes: Success. + * 0: Failure. + * Requires: + * Ensures: + */ + typedef u32(CDECL *DLDR_OVLYFXN) (void *pPrivRef, u32 ulDspRunAddr, + u32 ulDspLoadAddr, + u32 ulNumBytes, u32 nMemSpace); + +/* + * ======== DLDR_WRITEFXN ======== + * Write memory function. Used for dynamic load writes. + * Parameters: + * pPrivRef: Handle to identify the node. + * ulDspAddr: Address of code or data. + * pBuf: Code or data to be written + * ulNumBytes: Number of (GPP) bytes to write. + * nMemSpace: DBL_DATA or DBL_CODE. + * Returns: + * ulNumBytes: Success. + * 0: Failure. + * Requires: + * Ensures: + */ + typedef u32(CDECL *DLDR_WRITEFXN) (void *pPrivRef, + u32 ulDspAddr, + void *pBuf, + u32 ulNumBytes, u32 nMemSpace); + +/* + * ======== DLDR_ATTRS ======== + * Attributes passed to DLDR_Create function. + */ + struct DLDR_ATTRS { + DLDR_OVLYFXN pfnOvly; + DLDR_WRITEFXN pfnWrite; + u16 usDSPWordSize; + u16 usDSPMauSize; + } ; + +/* + * ======== DLDR_PHASE ======== + * Indicates node create, delete, or execute phase function. + */ + enum DLDR_PHASE { + DLDR_CREATE, + DLDR_DELETE, + DLDR_EXECUTE, + DLDR_NOPHASE + } ; + +/* + * Typedefs of loader functions imported from a DLL, or defined in a + * function table. + */ + +/* + * ======== DLDR_Allocate ======== + * Allocate resources to manage the loading of a node on the DSP. + * + * Parameters: + * hDldr: Handle of loader that will load the node. + * pPrivRef: Handle to identify the node. + * pNodeProps: Pointer to a DCD_NODEPROPS for the node. + * phDldrNode: Location to store node handle on output. This handle + * will be passed to DLDR_Load/DLDR_Unload. + * pfPhaseSplit: pointer to boolean variable referenced in node.c + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory on GPP. + * Requires: + * DLDR_Init() called. + * Valid hDldr. + * pNodeProps != NULL. + * phDldrNode != NULL. + * Ensures: + * DSP_SOK: IsValidNode(*phDldrNode). + * error: *phDldrNode == NULL. + */ + typedef DSP_STATUS(*DLDR_ALLOCATEFXN) (struct DLDR_OBJECT *hDldr, + void *pPrivRef, + IN CONST struct DCD_NODEPROPS * + pNodeProps, + OUT struct DLDR_NODEOBJECT + **phDldrNode, + OUT bool *pfPhaseSplit); + +/* + * ======== DLDR_Create ======== + * Create a loader object. This object handles the loading and unloading of + * create, delete, and execute phase functions of nodes on the DSP target. + * + * Parameters: + * phDldr: Location to store loader handle on output. + * hDevObject: Device for this processor. + * pAttrs: Loader attributes. + * Returns: + * DSP_SOK: Success; + * DSP_EMEMORY: Insufficient memory for requested resources. + * Requires: + * DLDR_Init() called. + * phDldr != NULL. + * hDevObject != NULL. + * pAttrs != NULL. + * Ensures: + * DSP_SOK: Valid *phDldr. + * error: *phDldr == NULL. + */ + typedef DSP_STATUS(*DLDR_CREATEFXN) (OUT struct DLDR_OBJECT **phDldr, + struct DEV_OBJECT *hDevObject, + IN CONST struct DLDR_ATTRS + *pAttrs); + +/* + * ======== DLDR_Delete ======== + * Delete the DLDR loader. + * + * Parameters: + * hDldr: Node manager object. + * Returns: + * Requires: + * DLDR_Init() called. + * Valid hDldr. + * Ensures: + * hDldr invalid + */ + typedef void(*DLDR_DELETEFXN) (struct DLDR_OBJECT *hDldr); + +/* + * ======== DLDR_Exit ======== + * Discontinue usage of DLDR module. + * + * Parameters: + * Returns: + * Requires: + * DLDR_Init() successfully called before. + * Ensures: + * Any resources acquired in DLDR_Init() will be freed when last DLDR + * client calls DLDR_Exit(). + */ + typedef void(*DLDR_EXITFXN) (); + +/* + * ======== DLDR_Free ======== + * Free resources allocated in DLDR_Allocate. + * + * Parameters: + * hDldrNode: Handle returned from DLDR_Allocate(). + * Returns: + * Requires: + * DLDR_Init() called. + * Valid hDldrNode. + * Ensures: + */ + typedef void(*DLDR_FREEFXN) (struct DLDR_NODEOBJECT *hDldrNode); + +/* + * ======== DLDR_GetFxnAddr ======== + * Get address of create, delete, or execute phase function of a node on + * the DSP. + * + * Parameters: + * hDldrNode: Handle returned from DLDR_Allocate(). + * pstrFxn: Name of function. + * pulAddr: Location to store function address. + * Returns: + * DSP_SOK: Success. + * DSP_ESYMBOL: Address of function not found. + * Requires: + * DLDR_Init() called. + * Valid hDldrNode. + * pulAddr != NULL; + * pstrFxn != NULL; + * Ensures: + */ + typedef DSP_STATUS(*DLDR_GETFXNADDRFXN) (struct DLDR_NODEOBJECT + *hDldrNode, + char *pstrFxn, u32 *pulAddr); + +/* + * ======== DLDR_Init ======== + * Initialize the DLDR module. + * + * Parameters: + * Returns: + * TRUE if initialization succeeded, FALSE otherwise. + * Ensures: + */ + typedef bool(*DLDR_INITFXN) (); + +/* + * ======== DLDR_Load ======== + * Load create, delete, or execute phase function of a node on the DSP. + * + * Parameters: + * hDldrNode: Handle returned from DLDR_Allocate(). + * phase: Type of function to load (create, delete, or execute). + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory on GPP. + * DSP_EOVERLAYMEMORY: Can't overlay phase because overlay memory + * is already in use. + * DSP_EDYNLOAD: Failure in dynamic loader library. + * DSP_EFWRITE: Failed to write phase's code or date to target. + * Requires: + * DLDR_Init() called. + * Valid hDldrNode. + * Ensures: + */ + typedef DSP_STATUS(*DLDR_LOADFXN) (struct DLDR_NODEOBJECT *hDldrNode, + enum DLDR_PHASE phase); + +/* + * ======== DLDR_Unload ======== + * Unload create, delete, or execute phase function of a node on the DSP. + * + * Parameters: + * hDldrNode: Handle returned from DLDR_Allocate(). + * phase: Node function to unload (create, delete, or execute). + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory on GPP. + * Requires: + * DLDR_Init() called. + * Valid hDldrNode. + * Ensures: + */ + typedef DSP_STATUS(*DLDR_UNLOADFXN) (struct DLDR_NODEOBJECT *hDldrNode, + enum DLDR_PHASE phase); + +/* + * ======== DLDR_FXNS ======== + */ + struct DLDR_FXNS { + DLDR_ALLOCATEFXN pfnAllocate; + DLDR_CREATEFXN pfnCreate; + DLDR_DELETEFXN pfnDelete; + DLDR_EXITFXN pfnExit; + DLDR_FREEFXN pfnFree; + DLDR_GETFXNADDRFXN pfnGetFxnAddr; + DLDR_INITFXN pfnInit; + DLDR_LOADFXN pfnLoad; + DLDR_UNLOADFXN pfnUnload; + } ; + +#endif /* DLDRDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/dmm.h b/arch/arm/plat-omap/include/bridge/dmm.h new file mode 100644 index 0000000..06dbdae --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dmm.h @@ -0,0 +1,85 @@ +/* + * bridge/inc/dmm.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dmm.h ======== + * Purpose: + * The Dynamic Memory Mapping(DMM) module manages the DSP Virtual address + * space that can be directly mapped to any MPU buffer or memory region + * + * Public Functions: + * + *! Revision History: + *! ================ + *! 20-Feb-2004 sb: Created. + *! + */ + +#ifndef DMM_ +#define DMM_ + +#include + + struct DMM_OBJECT; + +/* DMM attributes used in DMM_Create() */ + struct DMM_MGRATTRS { + u32 reserved; + } ; + +#define DMMPOOLSIZE 0x4000000 + +/* + * ======== DMM_GetHandle ======== + * Purpose: + * Return the dynamic memory manager object for this device. + * This is typically called from the client process. + */ + + extern DSP_STATUS DMM_GetHandle(DSP_HPROCESSOR hProcessor, + OUT struct DMM_OBJECT **phDmmMgr); + + extern DSP_STATUS DMM_ReserveMemory(struct DMM_OBJECT *hDmmMgr, + u32 size, + u32 *pRsvAddr); + + extern DSP_STATUS DMM_UnReserveMemory(struct DMM_OBJECT *hDmmMgr, + u32 rsvAddr); + + extern DSP_STATUS DMM_MapMemory(struct DMM_OBJECT *hDmmMgr, u32 addr, + u32 size); + + extern DSP_STATUS DMM_UnMapMemory(struct DMM_OBJECT *hDmmMgr, + u32 addr, + u32 *pSize); + + extern DSP_STATUS DMM_Destroy(struct DMM_OBJECT *hDmmMgr); + + extern DSP_STATUS DMM_DeleteTables(struct DMM_OBJECT *hDmmMgr); + + extern DSP_STATUS DMM_Create(OUT struct DMM_OBJECT **phDmmMgr, + struct DEV_OBJECT *hDevObject, + IN CONST struct DMM_MGRATTRS *pMgrAttrs); + + extern bool DMM_Init(); + + extern void DMM_Exit(); + + extern DSP_STATUS DMM_CreateTables(struct DMM_OBJECT *hDmmMgr, + u32 addr, u32 size); + extern u32 *DMM_GetPhysicalAddrTable(void); +#endif /* DMM_ */ diff --git a/arch/arm/plat-omap/include/bridge/dpc.h b/arch/arm/plat-omap/include/bridge/dpc.h new file mode 100644 index 0000000..8c7dfa9 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dpc.h @@ -0,0 +1,167 @@ +/* + * bridge/inc/dpc.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dpc.h ======== + * Purpose: + * Deferred Procedure Call(DPC) Services. + * + * Public Functions: + * DPC_Cancel + * DPC_Create + * DPC_Destroy + * DPC_Exit + * DPC_Init + * DPC_Schedule + * + *! Revision History: + *! ================ + *! 31-Jan-2000 rr: DPC_Destroy ensures Suceess and DPC Object is NULL. + *! 21-Jan-2000 ag: Updated comments per code review. + *! 06-Jan-2000 ag: Removed DPC_[Lower|Raise]IRQL[From|To]DispatchLevel. + *! 14-Jan-1998 gp: Added DPC_[Lower|Raise]IRQL[From|To]DispatchLevel. + *! 18-Aug-1997 cr: Added explicit CDECL identifiers. + *! 28-Jul-1996 gp: Created. + */ + +#ifndef DPC_ +#define DPC_ + + struct DPC_OBJECT; + +/* + * ======== DPC_PROC ======== + * Purpose: + * Deferred processing routine. Typically scheduled from an ISR to + * complete I/O processing. + * Parameters: + * pRefData: Ptr to user data: passed in via ISR_ScheduleDPC. + * Returns: + * Requires: + * The DPC should not block, or otherwise acquire resources. + * Interrupts to the processor are enabled. + * DPC_PROC executes in a critical section. + * Ensures: + * This DPC will not be reenterred on the same thread. + * However, the DPC may take hardware interrupts during execution. + * Interrupts to the processor are enabled. + */ + typedef void(CDECL *DPC_PROC) (void *pRefData); + +/* + * ======== DPC_Cancel ======== + * Purpose: + * Cancel a DPC previously scheduled by DPC_Schedule. + * Parameters: + * hDPC: A DPC object handle created in DPC_Create(). + * Returns: + * DSP_SOK: Scheduled DPC, if any, is cancelled. + * DSP_SFALSE: No DPC is currently scheduled for execution. + * DSP_EHANDLE: Invalid hDPC. + * Requires: + * Ensures: + * If the DPC has already executed, is executing, or was not yet + * scheduled, this function will have no effect. + */ + extern DSP_STATUS CDECL DPC_Cancel(IN struct DPC_OBJECT *hDPC); + +/* + * ======== DPC_Create ======== + * Purpose: + * Create a DPC object, allowing a client's own DPC procedure to be + * scheduled for a call with client reference data. + * Parameters: + * phDPC: Pointer to location to store DPC object. + * pfnDPC: Client's DPC procedure. + * pRefData: Pointer to user-defined reference data. + * Returns: + * DSP_SOK: DPC object created. + * DSP_EPOINTER: phDPC == NULL or pfnDPC == NULL. + * DSP_EMEMORY: Insufficient memory. + * Requires: + * Must not be called at interrupt time. + * Ensures: + * DSP_SOK: DPC object is created; + * else: *phDPC is set to NULL. + */ + extern DSP_STATUS CDECL DPC_Create(OUT struct DPC_OBJECT **phDPC, + IN DPC_PROC pfnDPC, + IN void *pRefData); + +/* + * ======== DPC_Destroy ======== + * Purpose: + * Cancel the last scheduled DPC, and deallocate a DPC object previously + * allocated with DPC_Create().Frees the Object only if the thread and + * the events are terminated successfuly. + * Parameters: + * hDPC: A DPC object handle created in DPC_Create(). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hDPC. + * Requires: + * All DPC's scheduled for the DPC object must have completed their + * processing. + * Ensures: + * (SUCCESS && hDPC is NULL) or DSP_EFAILED status + */ + extern DSP_STATUS CDECL DPC_Destroy(IN struct DPC_OBJECT *hDPC); + +/* + * ======== DPC_Exit ======== + * Purpose: + * Discontinue usage of the DPC module. + * Parameters: + * Returns: + * Requires: + * DPC_Init() was previously called. + * Ensures: + * Resources acquired in DPC_Init() are freed. + */ + extern void CDECL DPC_Exit(); + +/* + * ======== DPC_Init ======== + * Purpose: + * Initialize the DPC module's private state. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * A requirement for each of the other public DPC functions. + */ + extern bool CDECL DPC_Init(); + +/* + * ======== DPC_Schedule ======== + * Purpose: + * Schedule a deferred procedure call to be executed at a later time. + * Latency and order of DPC execution is platform specific. + * Parameters: + * hDPC: A DPC object handle created in DPC_Create(). + * Returns: + * DSP_SOK: An event is scheduled for deferred processing. + * DSP_EHANDLE: Invalid hDPC. + * Requires: + * See requirements for DPC_PROC. + * Ensures: + * DSP_SOK: The DPC will not be called before this function returns. + */ + extern DSP_STATUS CDECL DPC_Schedule(IN struct DPC_OBJECT *hDPC); + +#endif /* DPC_ */ diff --git a/arch/arm/plat-omap/include/bridge/drv.h b/arch/arm/plat-omap/include/bridge/drv.h new file mode 100644 index 0000000..eddc161 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/drv.h @@ -0,0 +1,434 @@ +/* + * bridge/inc/drv.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== drv.h ======== + * Purpose: + * DRV Resource allocation module. Driver Object gets Created + * at the time of Loading. It holds the List of Device Objects + * in the Syste, + * + * Public Functions: + * DRV_Create + * DRV_Destroy + * DRV_Exit + * DRV_GetDevObject + * DRV_GetDevExtension + * DRV_GetFirstDevObject + * DRV_GetNextDevObject + * DRV_GetNextDevExtension + * DRV_Init + * DRV_InsertDevObject + * DRV_RemoveDevObject + * DRV_RequestResources + * DRV_ReleaseResources + * + *! Revision History + *! ================ + *! 10-Feb-2004 vp: Added OMAP24xx specific definitions. + *! 14-Aug-2000 rr: Cleaned up. + *! 27-Jul-2000 rr: DRV_RequestResources split into two(Request and Release) + *! Device extension created to hold the DevNodeString. + *! 17-Jul-2000 rr: Driver Object holds the list of Device Objects. + *! Added DRV_Create, DRV_Destroy, DRV_GetDevObject, + *! DRV_GetFirst/NextDevObject, DRV_Insert/RemoveDevObject. + *! 12-Nov-1999 rr: New Flag defines for DRV_ASSIGN and DRV_RELEASE + *! 25-Oct-1999 rr: Resource Structure removed. + *! 15-Oct-1999 rr: New Resource structure created. + *! 05-Oct-1999 rr: Added DRV_RequestResources + *! Removed fxn'sDRV_RegisterMiniDriver(), + *! DRV_UnRegisterMiniDriver() + *! Removed Structures DSP_DRIVER & DRV_EXTENSION. + *! + *! 24-Sep-1999 rr: Added DRV_EXTENSION and DSP_DRIVER structures. + *! + */ + +#ifndef DRV_ +#define DRV_ + +#include + +#include + +#define DRV_ASSIGN 1 +#define DRV_RELEASE 0 + +#ifdef CONFIG_ARCH_OMAP3430 + +/* Provide the DSP Internal memory windows that can be accessed from L3 address + * space */ + +#define OMAP_GEM_BASE 0x107F8000 +#define OMAP_DSP_SIZE 0x00720000 + +/* MEM1 is L2 RAM + L2 Cache space */ +#define OMAP_DSP_MEM1_BASE 0x5C7F8000 +#define OMAP_DSP_MEM1_SIZE 0x18000 +#define OMAP_DSP_GEM1_BASE 0x107F8000 + + +/* MEM2 is L1P RAM/CACHE space */ +#define OMAP_DSP_MEM2_BASE 0x5CE00000 +#define OMAP_DSP_MEM2_SIZE 0x8000 +#define OMAP_DSP_GEM2_BASE 0x10E00000 + +/* MEM3 is L1D RAM/CACHE space */ +#define OMAP_DSP_MEM3_BASE 0x5CF04000 +#define OMAP_DSP_MEM3_SIZE 0x14000 +#define OMAP_DSP_GEM3_BASE 0x10F04000 + + +#define OMAP_IVA2_PRM_BASE 0x48306000 +#define OMAP_IVA2_PRM_SIZE 0x1000 + +#define OMAP_IVA2_CM_BASE 0x48004000 +#define OMAP_IVA2_CM_SIZE 0x1000 + +#define OMAP_PER_CM_BASE 0x48005000 +#define OMAP_PER_CM_SIZE 0x1000 + +#define OMAP_SYSC_BASE 0x48002000 +#define OMAP_SYSC_SIZE 0x1000 + +#define OMAP_MBOX_BASE 0x48094000 +#define OMAP_MBOX_SIZE 0x1000 + +#define OMAP_DMMU_BASE 0x5D000000 +#define OMAP_DMMU_SIZE 0x1000 + +#define OMAP_PRCM_VDD1_DOMAIN 1 +#define OMAP_PRCM_VDD2_DOMAIN 2 + +#endif + +#ifndef RES_CLEANUP_DISABLE + +/* GPP PROCESS CLEANUP Data structures */ + +/* New structure (member of process context) abstracts NODE resource info */ +struct NODE_RES_OBJECT { + DSP_HNODE hNode; + s32 nodeAllocated; /* Node status */ + s32 heapAllocated; /* Heap status */ + s32 streamsAllocated; /* Streams status */ + struct NODE_RES_OBJECT *next; +} ; + +/* New structure (member of process context) abstracts DMM resource info */ +struct DMM_RES_OBJECT { + s32 dmmAllocated; /* DMM status */ + u32 ulMpuAddr; + u32 ulDSPAddr; + u32 ulDSPResAddr; + u32 dmmSize; + HANDLE hProcessor; + struct DMM_RES_OBJECT *next; +} ; + +/* New structure (member of process context) abstracts DMM resource info */ +struct DSPHEAP_RES_OBJECT { + s32 heapAllocated; /* DMM status */ + u32 ulMpuAddr; + u32 ulDSPAddr; + u32 ulDSPResAddr; + u32 heapSize; + HANDLE hProcessor; + struct DSPHEAP_RES_OBJECT *next; +} ; + +/* New structure (member of process context) abstracts stream resource info */ +struct STRM_RES_OBJECT { + s32 streamAllocated; /* Stream status */ + DSP_HSTREAM hStream; + u32 uNumBufs; + u32 uDir; + struct STRM_RES_OBJECT *next; +} ; + +/* Overall Bridge process resource usage state */ +enum GPP_PROC_RES_STATE { + PROC_RES_ALLOCATED, + PROC_RES_FREED +} ; + +/* Process Context */ +struct PROCESS_CONTEXT{ + /* Process State */ + enum GPP_PROC_RES_STATE resState; + + /* Process ID (Same as UNIX process ID) */ + u32 pid; + + /* Pointer to next process context + * (To maintain a linked list of process contexts) */ + struct PROCESS_CONTEXT *next; + + /* Processor info to which the process is related */ + DSP_HPROCESSOR hProcessor; + + /* DSP Node resources */ + struct NODE_RES_OBJECT *pNodeList; + + /* DMM resources */ + struct DMM_RES_OBJECT *pDMMList; + + /* DSP Heap resources */ + struct DSPHEAP_RES_OBJECT *pDSPHEAPList; + + /* Stream resources */ + struct STRM_RES_OBJECT *pSTRMList; +} ; +#endif + +/* + * ======== DRV_Create ======== + * Purpose: + * Creates the Driver Object. This is done during the driver loading. + * There is only one Driver Object in the DSP/BIOS Bridge. + * Parameters: + * phDrvObject: Location to store created DRV Object handle. + * Returns: + * DSP_SOK: Sucess + * DSP_EMEMORY: Failed in Memory allocation + * DSP_EFAIL: General Failure + * Requires: + * DRV Initialized (cRefs > 0 ) + * phDrvObject != NULL. + * Ensures: + * DSP_SOK: - *phDrvObject is a valid DRV interface to the device. + * - List of DevObject Created and Initialized. + * - List of DevNode String created and intialized. + * - Registry is updated with the DRV Object. + * !DSP_SOK: DRV Object not created + * Details: + * There is one Driver Object for the Driver representing + * the driver itself. It contains the list of device + * Objects and the list of Device Extensions in the system. + * Also it can hold other neccessary + * information in its storage area. + */ + extern DSP_STATUS DRV_Create(struct DRV_OBJECT **phDrvObject); + +/* + * ======== DRV_Destroy ======== + * Purpose: + * destroys the Dev Object list, DrvExt list + * and destroy the DRV object + * Called upon driver unLoading.or unsuccesful loading of the driver. + * Parameters: + * hDrvObject: Handle to Driver object . + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Failed to destroy DRV Object + * Requires: + * DRV Initialized (cRegs > 0 ) + * hDrvObject is not NULL and a valid DRV handle . + * List of DevObject is Empty. + * List of DrvExt is Empty + * Ensures: + * DSP_SOK: - DRV Object destroyed and hDrvObject is not a valid + * DRV handle. + * - Registry is updated with "0" as the DRV Object. + */ + extern DSP_STATUS DRV_Destroy(struct DRV_OBJECT *hDrvObject); + +/* + * ======== DRV_Exit ======== + * Purpose: + * Exit the DRV module, freeing any modules initialized in DRV_Init. + * Parameters: + * Returns: + * Requires: + * Ensures: + */ + extern void DRV_Exit(); + +/* + * ======== DRV_GetFirstDevObject ======== + * Purpose: + * Returns the Ptr to the FirstDev Object in the List + * Parameters: + * Requires: + * DRV Initialized + * Returns: + * dwDevObject: Ptr to the First Dev Object as a u32 + * 0 if it fails to retrieve the First Dev Object + * Ensures: + */ + extern u32 DRV_GetFirstDevObject(); + +/* + * ======== DRV_GetFirstDevExtension ======== + * Purpose: + * Returns the Ptr to the First Device Extension in the List + * Parameters: + * Requires: + * DRV Initialized + * Returns: + * dwDevExtension: Ptr to the First Device Extension as a u32 + * 0: Failed to Get the Device Extension + * Ensures: + */ + extern u32 DRV_GetFirstDevExtension(); + +/* + * ======== DRV_GetDevObject ======== + * Purpose: + * Given a index, returns a handle to DevObject from the list + * Parameters: + * hDrvObject: Handle to the Manager + * phDevObject: Location to store the Dev Handle + * Requires: + * DRV Initialized + * uIndex >= 0 + * hDrvObject is not NULL and Valid DRV Object + * phDevObject is not NULL + * Device Object List not Empty + * Returns: + * DSP_SOK: Success + * DSP_EFAIL: Failed to Get the Dev Object + * Ensures: + * DSP_SOK: *phDevObject != NULL + * DSP_EFAIL: *phDevObject = NULL + */ + extern DSP_STATUS DRV_GetDevObject(u32 uIndex, + struct DRV_OBJECT *hDrvObject, + struct DEV_OBJECT **phDevObject); + +/* + * ======== DRV_GetNextDevObject ======== + * Purpose: + * Returns the Ptr to the Next Device Object from the the List + * Parameters: + * hDevObject: Handle to the Device Object + * Requires: + * DRV Initialized + * hDevObject != 0 + * Returns: + * dwDevObject: Ptr to the Next Dev Object as a u32 + * 0: If it fail to get the next Dev Object. + * Ensures: + */ + extern u32 DRV_GetNextDevObject(u32 hDevObject); + +/* + * ======== DRV_GetNextDevExtension ======== + * Purpose: + * Returns the Ptr to the Next Device Extension from the the List + * Parameters: + * hDevExtension: Handle to the Device Extension + * Requires: + * DRV Initialized + * hDevExtension != 0. + * Returns: + * dwDevExtension: Ptr to the Next Dev Extension + * 0: If it fail to Get the next Dev Extension + * Ensures: + */ + extern u32 DRV_GetNextDevExtension(u32 hDevExtension); + +/* + * ======== DRV_Init ======== + * Purpose: + * Initialize the DRV module. + * Parameters: + * Returns: + * TRUE if success; FALSE otherwise. + * Requires: + * Ensures: + */ + extern DSP_STATUS DRV_Init(); + +/* + * ======== DRV_InsertDevObject ======== + * Purpose: + * Insert a DeviceObject into the list of Driver object. + * Parameters: + * hDrvObject: Handle to DrvObject + * hDevObject: Handle to DeviceObject to insert. + * Returns: + * DSP_SOK: If successful. + * DSP_EFAIL: General Failure: + * Requires: + * hDrvObject != NULL and Valid DRV Handle. + * hDevObject != NULL. + * Ensures: + * DSP_SOK: Device Object is inserted and the List is not empty. + */ + extern DSP_STATUS DRV_InsertDevObject(struct DRV_OBJECT *hDrvObject, + struct DEV_OBJECT *hDevObject); + +/* + * ======== DRV_RemoveDevObject ======== + * Purpose: + * Search for and remove a Device object from the given list of Device Obj + * objects. + * Parameters: + * hDrvObject: Handle to DrvObject + * hDevObject: Handle to DevObject to Remove + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Unable to find pDevObject. + * Requires: + * hDrvObject != NULL and a Valid DRV Handle. + * hDevObject != NULL. + * List exists and is not empty. + * Ensures: + * List either does not exist (NULL), or is not empty if it does exist. +*/ + extern DSP_STATUS DRV_RemoveDevObject(struct DRV_OBJECT *hDrvObject, + struct DEV_OBJECT *hDevObject); + +/* + * ======== DRV_RequestResources ======== + * Purpose: + * Assigns the Resources or Releases them. + * Parameters: + * dwContext: Path to the driver Registry Key. + * pDevNodeString: Ptr to DevNode String stored in the Device Ext. + * Returns: + * TRUE if success; FALSE otherwise. + * Requires: + * Ensures: + * The Resources are assigned based on Bus type. + * The hardware is initialized. Resource information is + * gathered from the Registry(ISA, PCMCIA)or scanned(PCI) + * Resource structure is stored in the registry which will be + * later used by the CFG module. + */ + extern DSP_STATUS DRV_RequestResources(IN u32 dwContext, + OUT u32 *pDevNodeString); + +/* + * ======== DRV_ReleaseResources ======== + * Purpose: + * Assigns the Resources or Releases them. + * Parameters: + * dwContext: Path to the driver Registry Key. + * hDrvObject: Handle to the Driver Object. + * Returns: + * TRUE if success; FALSE otherwise. + * Requires: + * Ensures: + * The Resources are released based on Bus type. + * Resource structure is deleted from the registry + */ + extern DSP_STATUS DRV_ReleaseResources(IN u32 dwContext, + struct DRV_OBJECT *hDrvObject); + +#endif /* DRV_ */ diff --git a/arch/arm/plat-omap/include/bridge/drvdefs.h b/arch/arm/plat-omap/include/bridge/drvdefs.h new file mode 100644 index 0000000..72297ee --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/drvdefs.h @@ -0,0 +1,34 @@ +/* + * bridge/inc/drvdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== drvdefs.h ======== + * Purpose: + * Definition of common include typedef between wmd.h and drv.h. + * + *! Revision History: + *! ================ + *! 17-Jul-2000 rr: Created + */ + +#ifndef DRVDEFS_ +#define DRVDEFS_ + +/* WCD Driver Object */ + struct DRV_OBJECT; + +#endif /* DRVDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/dspapi.h b/arch/arm/plat-omap/include/bridge/dspapi.h new file mode 100644 index 0000000..1eaa81c --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dspapi.h @@ -0,0 +1,50 @@ +/* + * bridge/inc/dspapi.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dspapi.h ======== + * Purpose: + * Defines function type modifiers used in all DSPSYS public header + * files. + * + * Notes: + * Provides __stdcall (required by VB 4.0) and __declspec(dllimport) + * function modifiers for fast dyna-linking. + * + *! Revision History: + *! ================= + *! 23-Dec-1997 cr: Added WBKERNEL_API definition. + *! 11-Oct-1996 gp: Created. + */ + +#ifndef DSPAPI_ +#define DSPAPI_ + +/* Define API decoration for direct importing of DLL references. */ +#if !defined(_DSPSYSDLL32_) +#define DSPAPIDLL __declspec(dllimport) +#else +#define DSPAPIDLL +#endif + +/* Full export modifier: */ +#define DSPAPI DSPAPIDLL DSP_STATUS WINAPI + +/* Explicitly define class driver calling conventions */ +#define WBKERNEL_API CDECL + +#endif /* DSPAPI_ */ diff --git a/arch/arm/plat-omap/include/bridge/dspdrv.h b/arch/arm/plat-omap/include/bridge/dspdrv.h new file mode 100644 index 0000000..6581a07 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dspdrv.h @@ -0,0 +1,106 @@ +/* + * bridge/inc/dspdrv.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== dspdrv.h ======== + * Purpose: + * This is the Stream Interface for the DDSP Class driver. + * All Device operations are performed via DeviceIOControl. + * Read, Seek and Write not used. + * + * Public Functions + * DSP_Close + * DSP_Deinit + * DSP_Init + * DSP_IOControl + * DSP_Open + * DSP_PowerUp + * DSP_PowerDown + * + *! Revision History + *! ================ + *! 28-Jan-2000 rr: Type void changed to Void. + *! 02-Dec-1999 rr: MAX_DEV define moved from wcdce.c file.Code cleaned up. + *! 12-Nov-1999 rr: "#include removed. + *! 05-Oct-1999 rr Renamed the file name to wcdce.h Removed Bus Specific + *! code and #defines to PCCARD.h. + *! 24-Sep-1999 rr Changed the DSP_COMMON_WINDOW_SIZE to 0x4000(16k) for the + *! Memory windows. + *! 16-Jul-1999 ag Adapted from rkw's CAC Bullet driver. + *! + */ + +#if !defined __DSPDRV_h__ +#define __DSPDRV_h__ + +#define MAX_DEV 10 /* Max support of 10 devices */ + +/* + * ======== DSP_Close ======== + * Purpose: + * Called when the client application/driver unloads the DDSP DLL. Upon + * unloading, the DDSP DLL will call CloseFile(). + * Parameters: + * dwDeviceContext: Handle returned by XXX_Open used to identify + * the open context of the device + * Returns: + * TRUE indicates the device is successfully closed. FALSE indicates + * otherwise. + * Requires: + * dwOpenContext!= NULL. + * Ensures:The Application instance owned objects are cleaned up. + */ +extern bool DSP_Close(u32 dwDeviceContext); + +/* + * ======== DSP_Deinit ======== + * Purpose: + * This function is called by Device Manager to de-initialize a device. + * This function is not called by applications. + * Parameters: + * dwDeviceContext:Handle to the device context. The XXX_Init function + * creates and returns this identifier. + * Returns: + * TRUE indicates the device successfully de-initialized. Otherwise it + * returns FALSE. + * Requires: + * dwDeviceContext!= NULL. For a built in device this should never + * get called. + * Ensures: + */ +extern bool DSP_Deinit(u32 dwDeviceContext); + +/* + * ======== DSP_Init ======== + * Purpose: + * This function is called by Device Manager to initialize a device. + * This function is not called by applications + * Parameters: + * dwContext: Specifies a pointer to a string containing the registry + * path to the active key for the stream interface driver. + * HKEY_LOCAL_MACHINE\Drivers\Active + * Returns: + * Returns a handle to the device context created. This is the our actual + * Device Object representing the DSP Device instance. + * Requires: + * Ensures: + * Succeeded: device context > 0 + * Failed: device Context = 0 + */ +extern u32 DSP_Init(OUT u32 *initStatus); + +#endif diff --git a/arch/arm/plat-omap/include/bridge/dynamic_loader.h b/arch/arm/plat-omap/include/bridge/dynamic_loader.h new file mode 100644 index 0000000..2301331 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/dynamic_loader.h @@ -0,0 +1,505 @@ +/* + * bridge/inc/dynamic_loader.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + + +#ifndef _DYNAMIC_LOADER_H_ +#define _DYNAMIC_LOADER_H_ +#include +#include + +/* + * Dynamic Loader + * + * The function of the dynamic loader is to load a "module" containing + * instructions for a "target" processor into that processor. In the process + * it assigns memory for the module, resolves symbol references made by the + * module, and remembers symbols defined by the module. + * + * The dynamic loader is parameterized for a particular system by 4 classes + * that supply the module and system specific functions it requires + */ + /* The read functions for the module image to be loaded */ + struct Dynamic_Loader_Stream; + + /* This class defines "host" symbol and support functions */ + struct Dynamic_Loader_Sym; + + /* This class defines the allocator for "target" memory */ + struct Dynamic_Loader_Allocate; + + /* This class defines the copy-into-target-memory functions */ + struct Dynamic_Loader_Initialize; + +/* + * Option flags to modify the behavior of module loading + */ +#define DLOAD_INITBSS 0x1 /* initialize BSS sections to zero */ +#define DLOAD_BIGEND 0x2 /* require big-endian load module */ +#define DLOAD_LITTLE 0x4 /* require little-endian load module */ + + typedef void *DLOAD_mhandle; /* module handle for loaded modules */ + +/***************************************************************************** + * Procedure Dynamic_Load_Module + * + * Parameters: + * module The input stream that supplies the module image + * syms Host-side symbol table and malloc/free functions + * alloc Target-side memory allocation + * init Target-side memory initialization, or NULL for symbol read only + * options Option flags DLOAD_* + * mhandle A module handle for use with Dynamic_Unload + * + * Effect: + * The module image is read using *module. Target storage for the new image is + * obtained from *alloc. Symbols defined and referenced by the module are + * managed using *syms. The image is then relocated and references resolved + * as necessary, and the resulting executable bits are placed into target memory + * using *init. + * + * Returns: + * On a successful load, a module handle is placed in *mhandle, and zero is + * returned. On error, the number of errors detected is returned. Individual + * errors are reported during the load process using syms->Error_Report(). + *****************************************************************************/ + extern int Dynamic_Load_Module( + /* the source for the module image*/ + struct Dynamic_Loader_Stream *module, + /* host support for symbols and storage*/ + struct Dynamic_Loader_Sym *syms, + /* the target memory allocator*/ + struct Dynamic_Loader_Allocate *alloc, + /* the target memory initializer*/ + struct Dynamic_Loader_Initialize *init, + unsigned options, /* option flags*/ + /* the returned module handle*/ + DLOAD_mhandle *mhandle + ); + +/***************************************************************************** + * Procedure Dynamic_Open_Module + * + * Parameters: + * module The input stream that supplies the module image + * syms Host-side symbol table and malloc/free functions + * alloc Target-side memory allocation + * init Target-side memory initialization, or NULL for symbol read only + * options Option flags DLOAD_* + * mhandle A module handle for use with Dynamic_Unload + * + * Effect: + * The module image is read using *module. Target storage for the new image is + * obtained from *alloc. Symbols defined and referenced by the module are + * managed using *syms. The image is then relocated and references resolved + * as necessary, and the resulting executable bits are placed into target memory + * using *init. + * + * Returns: + * On a successful load, a module handle is placed in *mhandle, and zero is + * returned. On error, the number of errors detected is returned. Individual + * errors are reported during the load process using syms->Error_Report(). + *****************************************************************************/ + extern int Dynamic_Open_Module( + /* the source for the module image */ + struct Dynamic_Loader_Stream *module, + /* host support for symbols and storage */ + struct Dynamic_Loader_Sym *syms, + /* the target memory allocator */ + struct Dynamic_Loader_Allocate *alloc, + /* the target memory initializer */ + struct Dynamic_Loader_Initialize *init, + unsigned options, /* option flags */ + /* the returned module handle */ + DLOAD_mhandle *mhandle + ); + +/***************************************************************************** + * Procedure Dynamic_Unload_Module + * + * Parameters: + * mhandle A module handle from Dynamic_Load_Module + * syms Host-side symbol table and malloc/free functions + * alloc Target-side memory allocation + * + * Effect: + * The module specified by mhandle is unloaded. Unloading causes all + * target memory to be deallocated, all symbols defined by the module to + * be purged, and any host-side storage used by the dynamic loader for + * this module to be released. + * + * Returns: + * Zero for success. On error, the number of errors detected is returned. + * Individual errors are reported using syms->Error_Report(). + *****************************************************************************/ + extern int Dynamic_Unload_Module(DLOAD_mhandle mhandle, /* the module + * handle*/ + /* host support for symbols and + * storage */ + struct Dynamic_Loader_Sym *syms, + /* the target memory allocator*/ + struct Dynamic_Loader_Allocate *alloc, + /* the target memory initializer*/ + struct Dynamic_Loader_Initialize *init + ); + +/***************************************************************************** + ***************************************************************************** + * A class used by the dynamic loader for input of the module image + ***************************************************************************** + *****************************************************************************/ + struct Dynamic_Loader_Stream { +/* public: */ + /************************************************************************* + * read_buffer + * + * PARAMETERS : + * buffer Pointer to the buffer to fill + * bufsiz Amount of data desired in sizeof() units + * + * EFFECT : + * Reads the specified amount of data from the module input stream + * into the specified buffer. Returns the amount of data read in sizeof() + * units (which if less than the specification, represents an error). + * + * NOTES: + * In release 1 increments the file position by the number of bytes read + * + *************************************************************************/ + int (*read_buffer) (struct Dynamic_Loader_Stream *thisptr, + void *buffer, unsigned bufsiz); + + /************************************************************************* + * set_file_posn (release 1 only) + * + * PARAMETERS : + * posn Desired file position relative to start of file in sizeof() units. + * + * EFFECT : + * Adjusts the internal state of the stream object so that the next + * read_buffer call will begin to read at the specified offset from + * the beginning of the input module. Returns 0 for success, non-zero + * for failure. + * + *************************************************************************/ + int (*set_file_posn) (struct Dynamic_Loader_Stream *thisptr, + /* to be eliminated in release 2*/ + unsigned int posn); + + }; + +/***************************************************************************** + ***************************************************************************** + * A class used by the dynamic loader for symbol table support and + * miscellaneous host-side functions + ***************************************************************************** + *****************************************************************************/ + + typedef u32 LDR_ADDR; + +/* + * the structure of a symbol known to the dynamic loader + */ + struct dynload_symbol { + LDR_ADDR value; + } ; + + struct Dynamic_Loader_Sym { +/* public: */ + /************************************************************************* + * Find_Matching_Symbol + * + * PARAMETERS : + * name The name of the desired symbol + * + * EFFECT : + * Locates a symbol matching the name specified. A pointer to the + * symbol is returned if it exists; 0 is returned if no such symbol is + * found. + * + *************************************************************************/ + struct dynload_symbol *(*Find_Matching_Symbol) + (struct Dynamic_Loader_Sym * + thisptr, + const char *name); + + /************************************************************************* + * Add_To_Symbol_Table + * + * PARAMETERS : + * nname Pointer to the name of the new symbol + * moduleid An opaque module id assigned by the dynamic loader + * + * EFFECT : + * The new symbol is added to the table. A pointer to the symbol is + * returned, or NULL is returned for failure. + * + * NOTES: + * It is permissible for this function to return NULL; the effect is that + * the named symbol will not be available to resolve references in + * subsequent loads. Returning NULL will not cause the current load + * to fail. + *************************************************************************/ + struct dynload_symbol *(*Add_To_Symbol_Table) + (struct Dynamic_Loader_Sym * + thisptr, + const char *nname, + unsigned moduleid); + + /************************************************************************* + * Purge_Symbol_Table + * + * PARAMETERS : + * moduleid An opaque module id assigned by the dynamic loader + * + * EFFECT : + * Each symbol in the symbol table whose moduleid matches the argument + * is removed from the table. + *************************************************************************/ + void (*Purge_Symbol_Table) (struct Dynamic_Loader_Sym *thisptr, + unsigned moduleid); + + /************************************************************************* + * Allocate + * + * PARAMETERS : + * memsiz size of desired memory in sizeof() units + * + * EFFECT : + * Returns a pointer to some "host" memory for use by the dynamic + * loader, or NULL for failure. + * This function is serves as a replaceable form of "malloc" to + * allow the user to configure the memory usage of the dynamic loader. + *************************************************************************/ + void *(*Allocate) (struct Dynamic_Loader_Sym *thisptr, + unsigned memsiz); + + /************************************************************************* + * Deallocate + * + * PARAMETERS : + * memptr pointer to previously allocated memory + * + * EFFECT : + * Releases the previously allocated "host" memory. + *************************************************************************/ + void (*Deallocate) (struct Dynamic_Loader_Sym *thisptr, + void *memptr); + + /************************************************************************* + * Error_Report + * + * PARAMETERS : + * errstr pointer to an error string + * args additional arguments + * + * EFFECT : + * This function provides an error reporting interface for the dynamic + * loader. The error string and arguments are designed as for the + * library function vprintf. + *************************************************************************/ + void (*Error_Report) (struct Dynamic_Loader_Sym *thisptr, + const char *errstr, va_list args); + + }; /* class Dynamic_Loader_Sym */ + +/***************************************************************************** + ***************************************************************************** + * A class used by the dynamic loader to allocate and deallocate target memory. + ***************************************************************************** + *****************************************************************************/ + + struct LDR_SECTION_INFO { + /* Name of the memory section assigned at build time */ + const char *name; + LDR_ADDR run_addr; /* execution address of the section */ + LDR_ADDR load_addr; /* load address of the section */ + LDR_ADDR size; /* size of the section in addressable units */ +#ifndef _BIG_ENDIAN + u16 page; /* memory page or view */ + u16 type; /* one of the section types below */ +#else + u16 type; /* one of the section types below */ + u16 page; /* memory page or view */ +#endif + /* a context field for use by Dynamic_Loader_Allocate; + * ignored but maintained by the dynamic loader */ + u32 context; + } ; + +/* use this macro to extract type of section from LDR_SECTION_INFO.type field */ +#define DLOAD_SECTION_TYPE(typeinfo) (typeinfo & 0xF) + +/* type of section to be allocated */ +#define DLOAD_TEXT 0 +#define DLOAD_DATA 1 +#define DLOAD_BSS 2 + /* internal use only, run-time cinit will be of type DLOAD_DATA */ +#define DLOAD_CINIT 3 + + struct Dynamic_Loader_Allocate { +/* public: */ + + /************************************************************************* + * Function allocate + * + * Parameters: + * info A pointer to an information block for the section + * align The alignment of the storage in target AUs + * + * Effect: + * Allocates target memory for the specified section and fills in the + * load_addr and run_addr fields of the section info structure. Returns TRUE + * for success, FALSE for failure. + * + * Notes: + * Frequently load_addr and run_addr are the same, but if they are not + * load_addr is used with Dynamic_Loader_Initialize, and run_addr is + * used for almost all relocations. This function should always initialize + * both fields. + *************************************************************************/ + int (*Allocate) (struct Dynamic_Loader_Allocate *thisptr, + struct LDR_SECTION_INFO *info, unsigned align); + + /************************************************************************* + * Function deallocate + * + * Parameters: + * info A pointer to an information block for the section + * + * Effect: + * Releases the target memory previously allocated. + * + * Notes: + * The content of the info->name field is undefined on call to this function. + *************************************************************************/ + void (*Deallocate) (struct Dynamic_Loader_Allocate *thisptr, + struct LDR_SECTION_INFO *info); + + }; /* class Dynamic_Loader_Allocate */ + +/***************************************************************************** + ***************************************************************************** + * A class used by the dynamic loader to load data into a target. This class + * provides the interface-specific functions needed to load data. + ***************************************************************************** + *****************************************************************************/ + + struct Dynamic_Loader_Initialize { +/* public: */ + /************************************************************************* + * Function connect + * + * Parameters: + * none + * + * Effect: + * Connect to the initialization interface. Returns TRUE for success, + * FALSE for failure. + * + * Notes: + * This function is called prior to use of any other functions in + * this interface. + *************************************************************************/ + int (*connect) (struct Dynamic_Loader_Initialize *thisptr); + + /************************************************************************* + * Function readmem + * + * Parameters: + * bufr Pointer to a word-aligned buffer for the result + * locn Target address of first data element + * info Section info for the section in which the address resides + * bytsiz Size of the data to be read in sizeof() units + * + * Effect: + * Fills the specified buffer with data from the target. Returns TRUE for + * success, FALSE for failure. + *************************************************************************/ + int (*readmem) (struct Dynamic_Loader_Initialize *thisptr, + void *bufr, + LDR_ADDR locn, + struct LDR_SECTION_INFO *info, + unsigned bytsiz); + + /************************************************************************* + * Function writemem + * + * Parameters: + * bufr Pointer to a word-aligned buffer of data + * locn Target address of first data element to be written + * info Section info for the section in which the address resides + * bytsiz Size of the data to be written in sizeof() units + * + * Effect: + * Writes the specified buffer to the target. Returns TRUE for success, + * FALSE for failure. + *************************************************************************/ + int (*writemem) (struct Dynamic_Loader_Initialize *thisptr, + void *bufr, + LDR_ADDR locn, + struct LDR_SECTION_INFO *info, + unsigned bytsiz); + + /************************************************************************* + * Function fillmem + * + * Parameters: + * locn Target address of first data element to be written + * info Section info for the section in which the address resides + * bytsiz Size of the data to be written in sizeof() units + * val Value to be written in each byte + * Effect: + * Fills the specified area of target memory. Returns TRUE for success, + * FALSE for failure. + *************************************************************************/ + int (*fillmem) (struct Dynamic_Loader_Initialize *thisptr, + LDR_ADDR locn, struct LDR_SECTION_INFO *info, + unsigned bytsiz, unsigned val); + + /************************************************************************* + * Function execute + * + * Parameters: + * start Starting address + * + * Effect: + * The target code at the specified starting address is executed. + * + * Notes: + * This function is called at the end of the dynamic load process + * if the input module has specified a starting address. + *************************************************************************/ + int (*execute) (struct Dynamic_Loader_Initialize *thisptr, + LDR_ADDR start); + + /************************************************************************* + * Function release + * + * Parameters: + * none + * + * Effect: + * Releases the connection to the load interface. + * + * Notes: + * This function is called at the end of the dynamic load process. + *************************************************************************/ + void (*release) (struct Dynamic_Loader_Initialize *thisptr); + + }; /* class Dynamic_Loader_Initialize */ + +#endif /* _DYNAMIC_LOADER_H_ */ diff --git a/arch/arm/plat-omap/include/bridge/errbase.h b/arch/arm/plat-omap/include/bridge/errbase.h new file mode 100644 index 0000000..4cdc26c --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/errbase.h @@ -0,0 +1,509 @@ +/* + * bridge/inc/errbase.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== errbase.h ======== + * Description: + * Central repository for DSP/BIOS Bridge error and status code. + * + * Error codes are of the form: + * []_E + * + * Success codes are of the form: + * []_S + * + *! Revision History: + *! ================ + *! 24-Jan-2003 map Added DSP_SALREADYLOADED for persistent library checking + *! 23-Nov-2002 gp: Minor comment cleanup. + *! 13-May-2002 sg Added DSP_SALREADYASLEEP and DSP_SALREADYWAKE. + *! 18-Feb-2002 mk: Added DSP_EOVERLAYMEMORY, EFWRITE, ENOSECT. + *! 31-Jan-2002 mk: Added definitions of DSP_STRUE and DSP_SFALSE. + *! 29-Jan-2002 mk: Added definition of CFG_E_INSUFFICIENTBUFSIZE. + *! 24-Oct-2001 sp: Consolidated all the error codes into this file. + *! 24-Jul-2001 mk: Type-casted all definitions of WSX_STATUS types for + *! removal of compile warnings. + *! 22-Nov-1999 kc: Changes from code review. + *! 18-Aug-1999 rr: Ported From WSX. + *! 29-May-1996 gp: Removed WCD_ and WMD_ error ranges. Redefined format of + *! error codes. + *! 10-May-1996 gp: Created. + */ + +#ifndef ERRBASE_ +#define ERRBASE_ + +/* Base of generic errors and component errors */ +#define DSP_SBASE (DSP_STATUS)0x00008000 +#define DSP_EBASE (DSP_STATUS)0x80008000 + +#define DSP_COMP_EBASE (DSP_STATUS)0x80040200 +#define DSP_COMP_ELAST (DSP_STATUS)0x80047fff + +/* SUCCESS Codes */ + +/* Generic success code */ +#define DSP_SOK (DSP_SBASE + 0) + +/* GPP is already attached to this DSP processor */ +#define DSP_SALREADYATTACHED (DSP_SBASE + 1) + +/* This is the last object available for enumeration. */ +#define DSP_SENUMCOMPLETE (DSP_SBASE + 2) + +/* The DSP is already asleep. */ +#define DSP_SALREADYASLEEP (DSP_SBASE + 3) + +/* The DSP is already awake. */ +#define DSP_SALREADYAWAKE (DSP_SBASE + 4) + +/* TRUE */ +#define DSP_STRUE (DSP_SBASE + 5) + +/* FALSE */ +#define DSP_SFALSE (DSP_SBASE + 6) + +/* A library contains no dependent library references */ +#define DSP_SNODEPENDENTLIBS (DSP_SBASE + 7) + +/* A persistent library is already loaded by the dynamic loader */ +#define DSP_SALREADYLOADED (DSP_SBASE + 8) + +/* Some error occured, but it is OK to continue */ +#define DSP_OKTO_CONTINUE (DSP_SBASE + 9) + +/* FAILURE Codes */ + +/* The caller does not have access privileges to call this function */ +#define DSP_EACCESSDENIED (DSP_EBASE + 0) + +/* The Specified Connection already exists */ +#define DSP_EALREADYCONNECTED (DSP_EBASE + 1) + +/* The GPP must be detached from the DSP before this function is called */ +#define DSP_EATTACHED (DSP_EBASE + 2) + +/* During enumeration a change in the number or properties of the objects + * has occurred. */ +#define DSP_ECHANGEDURINGENUM (DSP_EBASE + 3) + +/* An error occurred while parsing the DSP executable file */ +#define DSP_ECORRUPTFILE (DSP_EBASE + 4) + +/* A failure occurred during a delete operation */ +#define DSP_EDELETE (DSP_EBASE + 5) + +/* The specified direction is invalid */ +#define DSP_EDIRECTION (DSP_EBASE + 6) + +/* A stream has been issued the maximum number of buffers allowed in the + * stream at once ; buffers must be reclaimed from the stream before any + * more can be issued. */ +#define DSP_ESTREAMFULL (DSP_EBASE + 7) + +/* A general failure occurred */ +#define DSP_EFAIL (DSP_EBASE + 8) + +/* The specified executable file could not be found. */ +#define DSP_EFILE (DSP_EBASE + 9) + +/* The specified handle is invalid. */ +#define DSP_EHANDLE (DSP_EBASE + 0xa) + +/* An invalid argument was specified. */ +#define DSP_EINVALIDARG (DSP_EBASE + 0xb) + +/* A memory allocation failure occurred. */ +#define DSP_EMEMORY (DSP_EBASE + 0xc) + +/* The requested operation is invalid for this node type. */ +#define DSP_ENODETYPE (DSP_EBASE + 0xd) + +/* No error text was found for the specified error code. */ +#define DSP_ENOERRTEXT (DSP_EBASE + 0xe) + +/* No more connections can be made for this node. */ +#define DSP_ENOMORECONNECTIONS (DSP_EBASE + 0xf) + +/* The indicated operation is not supported. */ +#define DSP_ENOTIMPL (DSP_EBASE + 0x10) + +/* I/O is currently pending. */ +#define DSP_EPENDING (DSP_EBASE + 0x11) + +/* An invalid pointer was specified. */ +#define DSP_EPOINTER (DSP_EBASE + 0x12) + +/* A parameter is specified outside its valid range. */ +#define DSP_ERANGE (DSP_EBASE + 0x13) + +/* An invalid size parameter was specified. */ +#define DSP_ESIZE (DSP_EBASE + 0x14) + +/* A stream creation failure occurred on the DSP. */ +#define DSP_ESTREAM (DSP_EBASE + 0x15) + +/* A task creation failure occurred on the DSP. */ +#define DSP_ETASK (DSP_EBASE + 0x16) + +/* A timeout occurred before the requested operation could complete. */ + +#define DSP_ETIMEOUT (DSP_EBASE + 0x17) + +/* A data truncation occurred, e.g., when requesting a descriptive error + * string, not enough space was allocated for the complete error message. */ + +#define DSP_ETRUNCATED (DSP_EBASE + 0x18) + +/* A parameter is invalid. */ +#define DSP_EVALUE (DSP_EBASE + 0x1a) + +/* The state of the specified object is incorrect for the requested + * operation. */ +#define DSP_EWRONGSTATE (DSP_EBASE + 0x1b) + +/* Symbol not found in the COFF file. DSPNode_Create will return this if + * the iAlg function table for an xDAIS socket is not found in the COFF file. + * In this case, force the symbol to be linked into the COFF file. + * DSPNode_Create, DSPNode_Execute, and DSPNode_Delete will return this if + * the create, execute, or delete phase function, respectively, could not be + * found in the COFF file. */ +#define DSP_ESYMBOL (DSP_EBASE + 0x1c) + +/* UUID not found in registry. */ +#define DSP_EUUID (DSP_EBASE + 0x1d) + +/* Unable to read content of DCD data section ; this is typically caused by + * improperly configured nodes. */ +#define DSP_EDCDREADSECT (DSP_EBASE + 0x1e) + +/* Unable to decode DCD data section content ; this is typically caused by + * changes to DSP/BIOS Bridge data structures. */ +#define DSP_EDCDPARSESECT (DSP_EBASE + 0x1f) + +/* Unable to get pointer to DCD data section ; this is typically caused by + * improperly configured UUIDs. */ +#define DSP_EDCDGETSECT (DSP_EBASE + 0x20) + +/* Unable to load file containing DCD data section ; this is typically + * caused by a missing COFF file. */ +#define DSP_EDCDLOADBASE (DSP_EBASE + 0x21) + +/* The specified COFF file does not contain a valid node registration + * section. */ +#define DSP_EDCDNOAUTOREGISTER (DSP_EBASE + 0x22) + +/* A requested resource is not available. */ +#define DSP_ERESOURCE (DSP_EBASE + 0x28) + +/* A critical error has occurred, and the DSP is being re-started. */ +#define DSP_ERESTART (DSP_EBASE + 0x29) + +/* A DSP memory free operation failed. */ +#define DSP_EFREE (DSP_EBASE + 0x2a) + +/* A DSP I/O free operation failed. */ +#define DSP_EIOFREE (DSP_EBASE + 0x2b) + +/* Multiple instances are not allowed. */ +#define DSP_EMULINST (DSP_EBASE + 0x2c) + +/* A specified entity was not found. */ +#define DSP_ENOTFOUND (DSP_EBASE + 0x2d) + +/* A DSP I/O resource is not available. */ +#define DSP_EOUTOFIO (DSP_EBASE + 0x2e) + +/* A shared memory buffer contained in a message or stream could not be + * mapped to the GPP client process's virtual space. */ +#define DSP_ETRANSLATE (DSP_EBASE + 0x2f) + +/* File or section load write function failed to write to DSP */ +#define DSP_EFWRITE (DSP_EBASE + 0x31) + +/* Unable to find a named section in DSP executable */ +#define DSP_ENOSECT (DSP_EBASE + 0x32) + +/* Unable to open file */ +#define DSP_EFOPEN (DSP_EBASE + 0x33) + +/* Unable to read file */ +#define DSP_EFREAD (DSP_EBASE + 0x34) + +/* A non-existent memory segment identifier was specified */ +#define DSP_EOVERLAYMEMORY (DSP_EBASE + 0x37) + +/* Invalid segment ID */ +#define DSP_EBADSEGID (DSP_EBASE + 0x38) + +/* Invalid alignment */ +#define DSP_EALIGNMENT (DSP_EBASE + 0x39) + +/* Invalid stream mode */ +#define DSP_ESTRMMODE (DSP_EBASE + 0x3a) + +/* Nodes not connected */ +#define DSP_ENOTCONNECTED (DSP_EBASE + 0x3b) + +/* Not shared memory */ +#define DSP_ENOTSHAREDMEM (DSP_EBASE + 0x3c) + +/* Error occurred in a dynamic loader library function */ +#define DSP_EDYNLOAD (DSP_EBASE + 0x3d) + +/* Device in 'sleep/suspend' mode due to DPM */ +#define DSP_EDPMSUSPEND (DSP_EBASE + 0x3e) + +/* A node-specific error has occurred. */ +#define DSP_EUSER1 (DSP_EBASE + 0x40) +#define DSP_EUSER2 (DSP_EBASE + 0x41) +#define DSP_EUSER3 (DSP_EBASE + 0x42) +#define DSP_EUSER4 (DSP_EBASE + 0x43) +#define DSP_EUSER5 (DSP_EBASE + 0x44) +#define DSP_EUSER6 (DSP_EBASE + 0x45) +#define DSP_EUSER7 (DSP_EBASE + 0x46) +#define DSP_EUSER8 (DSP_EBASE + 0x47) +#define DSP_EUSER9 (DSP_EBASE + 0x48) +#define DSP_EUSER10 (DSP_EBASE + 0x49) +#define DSP_EUSER11 (DSP_EBASE + 0x4a) +#define DSP_EUSER12 (DSP_EBASE + 0x4b) +#define DSP_EUSER13 (DSP_EBASE + 0x4c) +#define DSP_EUSER14 (DSP_EBASE + 0x4d) +#define DSP_EUSER15 (DSP_EBASE + 0x4e) +#define DSP_EUSER16 (DSP_EBASE + 0x4f) + +/* FAILURE Codes : DEV */ +#define DEV_EBASE (DSP_COMP_EBASE + 0x000) + +/* The mini-driver expected a newer version of the class driver. */ +#define DEV_E_NEWWMD (DEV_EBASE + 0x00) + +/* WMD_DRV_Entry function returned a NULL function interface table. */ +#define DEV_E_NULLWMDINTF (DEV_EBASE + 0x01) + +/* FAILURE Codes : LDR */ +#define LDR_EBASE (DSP_COMP_EBASE + 0x100) + +/* Insufficient memory to export class driver services. */ +#define LDR_E_NOMEMORY (LDR_EBASE + 0x00) + +/* Unable to find WMD file in system directory. */ +#define LDR_E_FILEUNABLETOOPEN (LDR_EBASE + 0x01) + +/* FAILURE Codes : CFG */ +#define CFG_EBASE (DSP_COMP_EBASE + 0x200) + +/* Invalid pointer passed into a configuration module function */ +#define CFG_E_INVALIDPOINTER (CFG_EBASE + 0x00) + +/* Invalid device node handle passed into a configuration module function. */ +#define CFG_E_INVALIDHDEVNODE (CFG_EBASE + 0x01) + +/* Unable to retrieve resource information from the registry. */ +#define CFG_E_RESOURCENOTAVAIL (CFG_EBASE + 0x02) + +/* Unable to find board name key in registry. */ +#define CFG_E_INVALIDBOARDNAME (CFG_EBASE + 0x03) + +/* Unable to find a device node in registry with given unit number. */ +#define CFG_E_INVALIDUNITNUM (CFG_EBASE + 0x04) + +/* Insufficient buffer size */ +#define CFG_E_INSUFFICIENTBUFSIZE (CFG_EBASE + 0x05) + +/* FAILURE Codes : BRD */ +#define BRD_EBASE (DSP_COMP_EBASE + 0x300) + +/* Board client does not have sufficient access rights for this operation. */ +#define BRD_E_ACCESSDENIED (BRD_EBASE + 0x00) + +/* Unable to find trace buffer symbols in the DSP executable COFF file. */ +#define BRD_E_NOTRACEBUFFER (BRD_EBASE + 0x01) + +/* Attempted to auto-start board, but no default DSP executable configured. */ +#define BRD_E_NOEXEC (BRD_EBASE + 0x02) + +/* The operation failed because it was started from a wrong state */ +#define BRD_E_WRONGSTATE (BRD_EBASE + 0x03) + +/* FAILURE Codes : COD */ +#define COD_EBASE (DSP_COMP_EBASE + 0x400) + +/* No symbol table is loaded for this board. */ +#define COD_E_NOSYMBOLSLOADED (COD_EBASE + 0x00) + +/* Symbol not found in for this board. */ +#define COD_E_SYMBOLNOTFOUND (COD_EBASE + 0x01) + +/* ZL DLL module is not exporting the correct function interface. */ +#define COD_E_NOZLFUNCTIONS (COD_EBASE + 0x02) + +/* Unable to initialize the ZL COFF parsing module. */ +#define COD_E_ZLCREATEFAILED (COD_EBASE + 0x03) + +/* Unable to open DSP executable COFF file. */ +#define COD_E_OPENFAILED (COD_EBASE + 0x04) + +/* Unable to parse DSP executable COFF file. */ +#define COD_E_LOADFAILED (COD_EBASE + 0x05) + +/* Unable to read DSP executable COFF file. */ +#define COD_E_READFAILED (COD_EBASE + 0x06) + +/* FAILURE Codes : CHNL */ +#define CHNL_EBASE (DSP_COMP_EBASE + 0x500) + +/* Attempt to created channel manager with too many channels. */ +#define CHNL_E_MAXCHANNELS (CHNL_EBASE + 0x00) + +/* No channel manager exists for this mini-driver. */ +#define CHNL_E_NOMGR (CHNL_EBASE + 0x01) + +/* No free channels are available. */ +#define CHNL_E_OUTOFSTREAMS (CHNL_EBASE + 0x02) + +/* Channel ID is out of range. */ +#define CHNL_E_BADCHANID (CHNL_EBASE + 0x03) + +/* Channel is already in use. */ +#define CHNL_E_CHANBUSY (CHNL_EBASE + 0x04) + +/* Invalid channel mode argument. */ +#define CHNL_E_BADMODE (CHNL_EBASE + 0x05) + +/* dwTimeOut parameter was CHNL_IOCNOWAIT, yet no I/O completions were + * queued. */ +#define CHNL_E_NOIOC (CHNL_EBASE + 0x06) + +/* I/O has been cancelled on this channel. */ +#define CHNL_E_CANCELLED (CHNL_EBASE + 0x07) + +/* End of stream was already requested on this output channel. */ +#define CHNL_E_EOS (CHNL_EBASE + 0x09) + +/* Unable to create the channel event object. */ +#define CHNL_E_CREATEEVENT (CHNL_EBASE + 0x0A) + +/* Board name and unit number do not identify a valid board name. */ +#define CHNL_E_BRDID (CHNL_EBASE + 0x0B) + +/* Invalid IRQ configured for this WMD for this system. */ +#define CHNL_E_INVALIDIRQ (CHNL_EBASE + 0x0C) + +/* DSP word size of zero configured for this device. */ +#define CHNL_E_INVALIDWORDSIZE (CHNL_EBASE + 0x0D) + +/* A zero length memory base was specified for a shared memory class driver. */ +#define CHNL_E_INVALIDMEMBASE (CHNL_EBASE + 0x0E) + +/* Memory map is not configured, or unable to map physical to linear + * address. */ +#define CHNL_E_NOMEMMAP (CHNL_EBASE + 0x0F) + +/* Attempted to create a channel manager when one already exists. */ +#define CHNL_E_MGREXISTS (CHNL_EBASE + 0x10) + +/* Unable to plug channel ISR for configured IRQ. */ +#define CHNL_E_ISR (CHNL_EBASE + 0x11) + +/* No free I/O request packets are available. */ +#define CHNL_E_NOIORPS (CHNL_EBASE + 0x12) + +/* Buffer size is larger than the size of physical channel. */ +#define CHNL_E_BUFSIZE (CHNL_EBASE + 0x13) + +/* User cannot mark end of stream on an input channel. */ +#define CHNL_E_NOEOS (CHNL_EBASE + 0x14) + +/* Wait for flush operation on an output channel timed out. */ +#define CHNL_E_WAITTIMEOUT (CHNL_EBASE + 0x15) + +/* User supplied hEvent must be specified with pstrEventName attribute */ +#define CHNL_E_BADUSEREVENT (CHNL_EBASE + 0x16) + +/* Illegal user event name specified */ +#define CHNL_E_USEREVENTNAME (CHNL_EBASE + 0x17) + +/* Unable to prepare buffer specified */ +#define CHNL_E_PREPFAILED (CHNL_EBASE + 0x18) + +/* Unable to Unprepare buffer specified */ +#define CHNL_E_UNPREPFAILED (CHNL_EBASE + 0x19) + +/* FAILURE Codes : SYNC */ +#define SYNC_EBASE (DSP_COMP_EBASE + 0x600) + +/* Wait on a kernel event failed. */ +#define SYNC_E_FAIL (SYNC_EBASE + 0x00) + +/* Timeout expired while waiting for event to be signalled. */ +#define SYNC_E_TIMEOUT (SYNC_EBASE + 0x01) + +/* FAILURE Codes : WMD */ +#define WMD_EBASE (DSP_COMP_EBASE + 0x700) + +/* A test of hardware assumptions or integrity failed. */ +#define WMD_E_HARDWARE (WMD_EBASE + 0x00) + +/* One or more configuration parameters violated WMD hardware assumptions. */ +#define WMD_E_BADCONFIG (WMD_EBASE + 0x01) + +/* Timeout occurred waiting for a response from the hardware. */ +#define WMD_E_TIMEOUT (WMD_EBASE + 0x02) + +/* FAILURE Codes : REG */ +#define REG_EBASE (DSP_COMP_EBASE + 0x800) + +/* Invalid subkey parameter. */ +#define REG_E_INVALIDSUBKEY (REG_EBASE + 0x00) + +/* Invalid entry parameter. */ +#define REG_E_INVALIDENTRY (REG_EBASE + 0x01) + +/* No more registry values. */ +#define REG_E_NOMOREITEMS (REG_EBASE + 0x02) + +/* Insufficient space to hold data in registry value. */ +#define REG_E_MOREDATA (REG_EBASE + 0x03) + +/* FAILURE Codes : KFILE */ +#define KFILE_EBASE (DSP_COMP_EBASE + 0x900) + +/* Invalid file handle. */ +#define E_KFILE_INVALIDHANDLE (KFILE_EBASE + 0x01) + +/* Bad file name. */ +#define E_KFILE_BADFILENAME (KFILE_EBASE + 0x02) + +/* Invalid file mode. */ +#define E_KFILE_INVALIDMODE (KFILE_EBASE + 0x03) + +/* No resources available. */ +#define E_KFILE_NORESOURCES (KFILE_EBASE + 0x04) + +/* Invalid file buffer . */ +#define E_KFILE_INVALIDBUFFER (KFILE_EBASE + 0x05) + +/* Bad origin argument. */ +#define E_KFILE_BADORIGINFLAG (KFILE_EBASE + 0x06) + +/* Invalid file offset value. */ +#define E_KFILE_INVALIDOFFSET (KFILE_EBASE + 0x07) + +/* General KFILE error condition */ +#define E_KFILE_ERROR (KFILE_EBASE + 0x08) + +#endif /* ERRBASE_ */ diff --git a/arch/arm/plat-omap/include/bridge/gb.h b/arch/arm/plat-omap/include/bridge/gb.h new file mode 100644 index 0000000..52ec3ec --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/gb.h @@ -0,0 +1,85 @@ +/* + * bridge/inc/gb.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== gb.h ======== + * Generic bitmap manager. + * + *! Revision History + *! ================ + */ + +#ifndef GB_ +#define GB_ + +#define GB_NOBITS (~0) +#include +typedef s32 GB_BitNum; +struct GB_TMap; + +/* + * ======== GB_clear ======== + * Clear the bit in position bitn in the bitmap map. Bit positions are + * zero based. + */ + +extern void GB_clear(struct GB_TMap *map, GB_BitNum bitn); + +/* + * ======== GB_create ======== + * Create a bit map with len bits. Initially all bits are cleared. + */ + +extern struct GB_TMap *GB_create(GB_BitNum len); + +/* + * ======== GB_delete ======== + * Delete previously created bit map + */ + +extern void GB_delete(struct GB_TMap *map); + +/* + * ======== GB_findandset ======== + * Finds a clear bit, sets it, and returns the position + */ + +extern GB_BitNum GB_findandset(struct GB_TMap *map); + +/* + * ======== GB_minclear ======== + * GB_minclear returns the minimum clear bit position. If no bit is + * clear, GB_minclear returns -1. + */ +extern GB_BitNum GB_minclear(struct GB_TMap *map); + +/* + * ======== GB_set ======== + * Set the bit in position bitn in the bitmap map. Bit positions are + * zero based. + */ + +extern void GB_set(struct GB_TMap *map, GB_BitNum bitn); + +/* + * ======== GB_test ======== + * Returns TRUE if the bit in position bitn is set in map; otherwise + * GB_test returns FALSE. Bit positions are zero based. + */ + +extern bool GB_test(struct GB_TMap *map, GB_BitNum bitn); + +#endif /*GB_ */ diff --git a/arch/arm/plat-omap/include/bridge/getsection.h b/arch/arm/plat-omap/include/bridge/getsection.h new file mode 100644 index 0000000..dd6f8a0 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/getsection.h @@ -0,0 +1,121 @@ +/* + * bridge/inc/getsection.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +#ifndef _GETSECTION_H_ +#define _GETSECTION_H_ + +#ifndef _SIZE_T /* Linux sets _SIZE_T on defining size_t */ +typedef unsigned int size_t; +#define _SIZE_T +#endif +#include "dynamic_loader.h" + +/* + * Get Section Information + * + * This file provides an API add-on to the dynamic loader that allows the user + * to query section information and extract section data from dynamic load + * modules. + * + * NOTE: + * Functions in this API assume that the supplied Dynamic_Loader_Stream object + * supports the set_file_posn method. + */ + + /* opaque handle for module information */ + typedef void *DLOAD_module_info; + +/* + * Procedure DLOAD_module_open + * + * Parameters: + * module The input stream that supplies the module image + * syms Host-side malloc/free and error reporting functions. + * Other methods are unused. + * + * Effect: + * Reads header information from a dynamic loader module using the specified + * stream object, and returns a handle for the module information. This + * handle may be used in subsequent query calls to obtain information + * contained in the module. + * + * Returns: + * NULL if an error is encountered, otherwise a module handle for use + * in subsequent operations. + */ + extern DLOAD_module_info DLOAD_module_open(struct Dynamic_Loader_Stream + *module, + struct Dynamic_Loader_Sym + *syms); + +/* + * Procedure DLOAD_GetSectionInfo + * + * Parameters: + * minfo Handle from DLOAD_module_open for this module + * sectionName Pointer to the string name of the section desired + * sectionInfo Address of a section info structure pointer to be initialized + * + * Effect: + * Finds the specified section in the module information, and fills in + * the provided LDR_SECTION_INFO structure. + * + * Returns: + * TRUE for success, FALSE for section not found + */ + extern int DLOAD_GetSectionInfo(DLOAD_module_info minfo, + const char *sectionName, + const struct LDR_SECTION_INFO + ** const sectionInfo); + +/* + * Procedure DLOAD_GetSection + * + * Parameters: + * minfo Handle from DLOAD_module_open for this module + * sectionInfo Pointer to a section info structure for the desired section + * sectionData Buffer to contain the section initialized data + * + * Effect: + * Copies the initialized data for the specified section into the + * supplied buffer. + * + * Returns: + * TRUE for success, FALSE for section not found + */ + extern int DLOAD_GetSection(DLOAD_module_info minfo, + const struct LDR_SECTION_INFO *sectionInfo, + void *sectionData); + +/* + * Procedure DLOAD_module_close + * + * Parameters: + * minfo Handle from DLOAD_module_open for this module + * + * Effect: + * Releases any storage associated with the module handle. On return, + * the module handle is invalid. + * + * Returns: + * Zero for success. On error, the number of errors detected is returned. + * Individual errors are reported using syms->Error_Report(), where syms was + * an argument to DLOAD_module_open + */ + extern void DLOAD_module_close(DLOAD_module_info minfo); + +#endif /* _GETSECTION_H_ */ diff --git a/arch/arm/plat-omap/include/bridge/gh.h b/arch/arm/plat-omap/include/bridge/gh.h new file mode 100644 index 0000000..3fd6802 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/gh.h @@ -0,0 +1,37 @@ +/* + * bridge/inc/gh.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== gh.h ======== + * + *! Revision History + *! ================ + */ + +#ifndef GH_ +#define GH_ +#include + +extern struct GH_THashTab *GH_create(u16 maxBucket, u16 valSize, + u16(*hash) (void *, u16), bool(*match) (void *, void *), + void(*delete) (void *)); +extern void GH_delete(struct GH_THashTab *hashTab); +extern void GH_exit(void); +extern void *GH_find(struct GH_THashTab *hashTab, void *key); +extern void GH_init(void); +extern void *GH_insert(struct GH_THashTab *hashTab, void *key, void *value); +#endif /* GH_ */ diff --git a/arch/arm/plat-omap/include/bridge/gp.h b/arch/arm/plat-omap/include/bridge/gp.h new file mode 100644 index 0000000..9e8e37a --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/gp.h @@ -0,0 +1,33 @@ +/* + * bridge/inc/gp.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== gp.h ======== + *! Revision History + *! ================ + */ + +#ifndef GP_ +#define GP_ + +#include + +/* + * ======== GP_snprintf ======== + */ +#define GP_snprintf snprintf + +#endif diff --git a/arch/arm/plat-omap/include/bridge/gs.h b/arch/arm/plat-omap/include/bridge/gs.h new file mode 100644 index 0000000..a4d6fff --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/gs.h @@ -0,0 +1,64 @@ +/* + * bridge/inc/gs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== gs.h ======== + * Memory allocation/release wrappers. This module allows clients to + * avoid OS spacific issues related to memory allocation. It also provides + * simple diagnostic capabilities to assist in the detection of memory + * leaks. + *! Revision History + *! ================ + */ + +#ifndef GS_ +#define GS_ + +/* + * ======== GS_alloc ======== + * Alloc size bytes of space. Returns pointer to space + * allocated, otherwise NULL. + */ +extern void *GS_alloc(u32 size); + +/* + * ======== GS_exit ======== + * Module exit. Do not change to "#define GS_init()"; in + * some environments this operation must actually do some work! + */ +extern void GS_exit(void); + +/* + * ======== GS_free ======== + * Free space allocated by GS_alloc() or GS_calloc(). + */ +extern void GS_free(void *ptr); + +/* + * ======== GS_frees ======== + * Free space allocated by GS_alloc() or GS_calloc() and assert that + * the size of the allocation is size bytes. + */ +extern void GS_frees(void *ptr, u32 size); + +/* + * ======== GS_init ======== + * Module initialization. Do not change to "#define GS_init()"; in + * some environments this operation must actually do some work! + */ +extern void GS_init(void); + +#endif /*GS_ */ diff --git a/arch/arm/plat-omap/include/bridge/gt.h b/arch/arm/plat-omap/include/bridge/gt.h new file mode 100644 index 0000000..8f12ece --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/gt.h @@ -0,0 +1,317 @@ +/* + * bridge/inc/gt.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== gt.h ======== + * Purpose: + * There are two definitions that affect which portions of trace + * are acutally compiled into the client: GT_TRACE and GT_ASSERT. If + * GT_TRACE is set to 0 then all trace statements (except for assertions) + * will be compiled out of the client. If GT_ASSERT is set to 0 then + * assertions will be compiled out of the client. GT_ASSERT can not be + * set to 0 unless GT_TRACE is also set to 0 (i.e. GT_TRACE == 1 implies + * GT_ASSERT == 1). + * + *! Revision History + *! ================ + *! 02-Feb-2000 rr: Renamed this file to gtce.h. GT CLASS and trace definitions + *! are WinCE Specific. + *! 03-Jan-1997 ge Replaced "GT_" prefix to GT_Config structure members + *! to eliminate preprocessor confusion with other macros. + */ +#include +#ifndef GT_ +#define GT_ + +#ifndef GT_TRACE +#define GT_TRACE 0 /* 0 = "trace compiled out"; 1 = "trace active" */ +#endif + +#include + +#if !defined(GT_ASSERT) || GT_TRACE +#define GT_ASSERT 1 +#endif + +struct GT_Config { + Fxn PRINTFXN; + Fxn PIDFXN; + Fxn TIDFXN; + Fxn ERRORFXN; +}; + +extern struct GT_Config *GT; + +struct GT_Mask { + char *modName; + u8 *flags; +} ; + +/* + * New GT Class defenitions. + * + * The following are the explanations and how it could be used in the code + * + * - GT_ENTER On Entry to Functions + * + * - GT_1CLASS Display level of debugging status- Object/Automatic + * variables + * - GT_2CLASS ---- do ---- + * + * - GT_3CLASS ---- do ---- + It can be used(recommended) for debug + * status in the ISR, IST + * - GT_4CLASS ---- do ---- + * + * - GT_5CLASS Display entry for module init/exit functions + * + * - GT_6CLASS Warn whenever SERVICES function fails + * + * - GT_7CLASS Warn failure of Critical failures + * + */ + +#define GT_ENTER ((u8)0x01) +#define GT_1CLASS ((u8)0x02) +#define GT_2CLASS ((u8)0x04) +#define GT_3CLASS ((u8)0x08) +#define GT_4CLASS ((u8)0x10) +#define GT_5CLASS ((u8)0x20) +#define GT_6CLASS ((u8)0x40) +#define GT_7CLASS ((u8)0x80) + +#ifdef _LINT_ + +/* LINTLIBRARY */ + +/* + * ======== GT_assert ======== + */ +/* ARGSUSED */ +void GT_assert(struct GT_Mask mask, s32 expr) +{ +} + +/* + * ======== GT_config ======== + */ +/* ARGSUSED */ +void GT_config(struct GT_Config config) +{ +} + +/* + * ======== GT_create ======== + */ +/* ARGSUSED */ +void GT_create(struct GT_Mask *mask, char *modName) +{ +} + +/* + * ======== GT_curLine ======== + * Purpose: + * Returns the current source code line number. Is useful for performing + * branch testing using trace. For example, + * + * GT_1trace(curTrace, GT_1CLASS, + * "in module XX_mod, executing line %u\n", GT_curLine()); + */ +/* ARGSUSED */ +u16 GT_curLine(void) +{ + return (u16)NULL; +} + +/* + * ======== GT_exit ======== + */ +/* ARGSUSED */ +void GT_exit(void) +{ +} + +/* + * ======== GT_init ======== + */ +/* ARGSUSED */ +void GT_init(void) +{ +} + +/* + * ======== GT_query ======== + */ +/* ARGSUSED */ +bool GT_query(struct GT_Mask mask, u8 class) +{ + return false; +} + +/* + * ======== GT_set ======== + * sets trace mask according to settings + */ + +/* ARGSUSED */ +void GT_set(char *settings) +{ +} + +/* + * ======== GT_setprintf ======== + * sets printf function + */ + +/* ARGSUSED */ +void GT_setprintf(Fxn fxn) +{ +} + +/* ARGSUSED */ +void GT_0trace(struct GT_Mask mask, u8 class, char *format) +{ +} + +/* ARGSUSED */ +void GT_1trace(struct GT_Mask mask, u8 class, char *format, ...) +{ +} + +/* ARGSUSED */ +void GT_2trace(struct GT_Mask mask, u8 class, char *format, ...) +{ +} + +/* ARGSUSED */ +void GT_3trace(struct GT_Mask mask, u8 class, char *format, ...) +{ +} + +/* ARGSUSED */ +void GT_4trace(struct GT_Mask mask, u8 class, char *format, ...) +{ +} + +/* ARGSUSED */ +void GT_5trace(struct GT_Mask mask, u8 class, char *format, ...) +{ +} + +/* ARGSUSED */ +void GT_6trace(struct GT_Mask mask, u8 class, char *format, ...) +{ +} + +#else + +#define GT_BOUND 26 /* 26 letters in alphabet */ + +extern void _GT_create(struct GT_Mask *mask, char *modName); + +#define GT_exit() + +extern void GT_init(void); +extern void _GT_set(char *str); +extern s32 _GT_trace(struct GT_Mask *mask, char *format, ...); + +#if GT_ASSERT == 0 + +#define GT_assert(mask, expr) +#define GT_config(config) +#define GT_configInit(config) +#define GT_seterror(fxn) + +#else + +extern struct GT_Config _GT_params; + +#define GT_assert(mask, expr) \ + (!(expr) ? \ + (*GT->ERRORFXN)("assertion violation: %s, line %d\n", \ + __FILE__, __LINE__), NULL : NULL) + +#define GT_config(config) (_GT_params = *(config)) +#define GT_configInit(config) (*(config) = _GT_params) +#define GT_seterror(fxn) (_GT_params.ERRORFXN = (Fxn)(fxn)) + +#endif + +#if GT_TRACE == 0 + +#define GT_curLine() ((u16)__LINE__) +#define GT_create(mask, modName) +#define GT_exit() +#define GT_init() +#define GT_set(settings) +#define GT_setprintf(fxn) + +#define GT_query(mask, class) false + +#define GT_0trace(mask, class, format) +#define GT_1trace(mask, class, format, arg1) +#define GT_2trace(mask, class, format, arg1, arg2) +#define GT_3trace(mask, class, format, arg1, arg2, arg3) +#define GT_4trace(mask, class, format, arg1, arg2, arg3, arg4) +#define GT_5trace(mask, class, format, arg1, arg2, arg3, arg4, arg5) +#define GT_6trace(mask, class, format, arg1, arg2, arg3, arg4, arg5, arg6) + +#else /* GT_TRACE == 1 */ + +extern char *GT_format; +extern u8 *GT_tMask[GT_BOUND]; + +#define GT_create(mask, modName) _GT_create((mask), (modName)) +#define GT_curLine() ((u16)__LINE__) +#define GT_set(settings) _GT_set(settings) +#define GT_setprintf(fxn) (_GT_params.PRINTFXN = (Fxn)(fxn)) + +#define GT_query(mask, class) ((*(mask).flags & (class))) + +#define GT_0trace(mask, class, format) \ + ((*(mask).flags & (class)) ? \ + _GT_trace(&(mask), (format)) : 0) + +#define GT_1trace(mask, class, format, arg1) \ + ((*(mask).flags & (class)) ? \ + _GT_trace(&(mask), (format), (arg1)) : 0) + +#define GT_2trace(mask, class, format, arg1, arg2) \ + ((*(mask).flags & (class)) ? \ + _GT_trace(&(mask), (format), (arg1), (arg2)) : 0) + +#define GT_3trace(mask, class, format, arg1, arg2, arg3) \ + ((*(mask).flags & (class)) ? \ + _GT_trace(&(mask), (format), (arg1), (arg2), (arg3)) : 0) + +#define GT_4trace(mask, class, format, arg1, arg2, arg3, arg4) \ + ((*(mask).flags & (class)) ? \ + _GT_trace(&(mask), (format), (arg1), (arg2), (arg3), (arg4)) : 0) + +#define GT_5trace(mask, class, format, arg1, arg2, arg3, arg4, arg5) \ + ((*(mask).flags & (class)) ? \ + _GT_trace(&(mask), (format), (arg1), (arg2), (arg3), (arg4), (arg5)) : 0) + +#define GT_6trace(mask, class, format, arg1, arg2, arg3, arg4, arg5, arg6) \ + ((*(mask).flags & (class)) ? \ + _GT_trace(&(mask), (format), (arg1), (arg2), (arg3), (arg4), (arg5), \ + (arg6)) : 0) + +#endif /* GT_TRACE */ + +#endif /* _LINT_ */ + +#endif /* GTCE_ */ diff --git a/arch/arm/plat-omap/include/bridge/host_os.h b/arch/arm/plat-omap/include/bridge/host_os.h new file mode 100644 index 0000000..93297ae --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/host_os.h @@ -0,0 +1,80 @@ +/* + * bridge/inc/host_os.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== windows.h ======== + * + *! Revision History + *! ================ + *! 08-Mar-2004 sb Added cacheflush.h to support Dynamic Memory Mapping feature + *! 16-Feb-2004 sb Added headers required for consistent_alloc + */ + +#ifndef _HOST_OS_H_ +#define _HOST_OS_H_ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#if defined(CONFIG_ARCH_OMAP2430) || defined(CONFIG_ARCH_OMAP3430) +#include +#ifdef CONFIG_ARCH_OMAP3430 +#include +#endif +#endif + +#include +#include +#include + +/* ----------------------------------- Macros */ + +#define SEEK_SET 0 /* Seek from beginning of file. */ +#define SEEK_CUR 1 /* Seek from current position. */ +#define SEEK_END 2 /* Seek from end of file. */ + +/* TODO -- Remove, once BP defines them */ +#ifdef CONFIG_ARCH_OMAP3430 +#define INT_MAIL_MPU_IRQ 26 +#define INT_DSP_MMU_IRQ 28 +#endif + +#endif diff --git a/arch/arm/plat-omap/include/bridge/io.h b/arch/arm/plat-omap/include/bridge/io.h new file mode 100644 index 0000000..a7451d7 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/io.h @@ -0,0 +1,132 @@ +/* + * bridge/inc/io.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== io.h ======== + * Description: + * The io module manages IO between CHNL and MSG. + * + * Public Functions: + * IO_Create + * IO_Destroy + * IO_Exit + * IO_Init + * IO_OnLoaded + * + * + *! Revision History: + *! ================ + *! 07-Nov-2000 jeh Created. + */ + +#ifndef IO_ +#define IO_ + +#include +#include + +#include + +/* + * ======== IO_Create ======== + * Purpose: + * Create an IO manager object, responsible for managing IO between + * CHNL and MSG. + * Parameters: + * phChnlMgr: Location to store a channel manager object on + * output. + * hDevObject: Handle to a device object. + * pMgrAttrs: IO manager attributes. + * pMgrAttrs->bIRQ: I/O IRQ number. + * pMgrAttrs->fShared: TRUE if the IRQ is shareable. + * pMgrAttrs->uWordSize: DSP Word size in equivalent PC bytes.. + * Returns: + * DSP_SOK: Success; + * DSP_EMEMORY: Insufficient memory for requested resources. + * CHNL_E_ISR: Unable to plug channel ISR for configured IRQ. + * CHNL_E_INVALIDIRQ: Invalid IRQ number. Must be 0 <= bIRQ <= 15. + * CHNL_E_INVALIDWORDSIZE: Invalid DSP word size. Must be > 0. + * CHNL_E_INVALIDMEMBASE: Invalid base address for DSP communications. + * Requires: + * IO_Init() called. + * phIOMgr != NULL. + * pMgrAttrs != NULL. + * Ensures: + */ + extern DSP_STATUS IO_Create(OUT struct IO_MGR **phIOMgr, + struct DEV_OBJECT *hDevObject, + IN CONST struct IO_ATTRS *pMgrAttrs); + +/* + * ======== IO_Destroy ======== + * Purpose: + * Destroy the IO manager. + * Parameters: + * hIOMgr: IOmanager object. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: hIOMgr was invalid. + * Requires: + * IO_Init() called. + * Ensures: + */ + extern DSP_STATUS IO_Destroy(struct IO_MGR *hIOMgr); + +/* + * ======== IO_Exit ======== + * Purpose: + * Discontinue usage of the IO module. + * Parameters: + * Returns: + * Requires: + * IO_Init() previously called. + * Ensures: + * Resources, if any acquired in IO_Init(), are freed when the last + * client of IO calls IO_Exit(). + */ + extern void IO_Exit(); + +/* + * ======== IO_Init ======== + * Purpose: + * Initialize the IO module's private state. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occurred. + * Requires: + * Ensures: + * A requirement for each of the other public CHNL functions. + */ + extern bool IO_Init(); + +/* + * ======== IO_OnLoaded ======== + * Purpose: + * Called when a program is loaded so IO manager can update its + * internal state. + * Parameters: + * hIOMgr: IOmanager object. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: hIOMgr was invalid. + * Requires: + * IO_Init() called. + * Ensures: + */ + extern DSP_STATUS IO_OnLoaded(struct IO_MGR *hIOMgr); + +#endif /* CHNL_ */ diff --git a/arch/arm/plat-omap/include/bridge/io_sm.h b/arch/arm/plat-omap/include/bridge/io_sm.h new file mode 100644 index 0000000..413108f --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/io_sm.h @@ -0,0 +1,330 @@ +/* + * bridge/inc/io_sm.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== io_sm.h ======== + * Description: + * IO dispatcher for a shared memory channel driver. + * Also, includes macros to simulate SHM via port io calls. + * + * Public Functions: + * IO_Dispatch + * IO_DPC + * IO_ISR + * IO_RequestChnl + * + * Notes: + * + *! Revision History: + *! ================ + *! 01-Mar-2004 vp: Added IVA releated functions. + *! 23-Apr-2003 sb: Fixed mailbox deadlock + *! 06-Feb-2003 kc Added IO_DDMAClearChnlDesc and IO_DDZCClearChnlDesc. + *! 21-Dec-2001 ag Removed unused param in IO_DDMAInitChnlDesc(). + * Updated comments. Removed #ifdef CHNL_NOIPCINTR. + *! 05-Nov-2001 kc Updated IO_CALLISR macro. + *! 01-May-2001 jeh Removed IO_RequestMsg. + *! 29-Mar-2001 ag Added #ifdef CHNL_NOIPCINTR. + *! 04-Dec-2000 jeh Added IO_RequestMsg. + *! 26-Oct-2000 jeh Added IO_GetLong, IO_SetLong, IO_ReadValueLong, and + *! IO_WriteValueLong, for passing arg in SHM structure. + *! 20-Jan-2000 ag: Updated header comments per code review. + *! 05-Jan-2000 ag: Text format clean-up. + *! 02-Nov-1999 ag: Updated header descriptions. + *! 25-May-1999 jg: Removed assumption of 4 bytes / word. + *! 12-Aug-1996 gp: Created. + */ + +#ifndef IOSM_ +#define IOSM_ + +#include <_chnl_sm.h> +#include + +#include + +#define IO_INPUT 0 +#define IO_OUTPUT 1 +#define IO_SERVICE 2 +#define IO_MAXSERVICE IO_SERVICE + +#define IO_MGRSIGNATURE 0x494f4D43 /* "IOGR" */ + +#define DSPFieldAddr(type, field, base, wordsize) \ + ((((s32)&(((type *)0)->field)) / wordsize) + (u32)base) + +/* Access can be different SM access word size (e.g. 16/32 bit words) */ +#define IO_SetValue(pContext, type, base, field, value) (base->field = value) +#define IO_GetValue(pContext, type, base, field) (base->field) +#define IO_OrValue(pContext, type, base, field, value) (base->field |= value) +#define IO_AndValue(pContext, type, base, field, value) (base->field &= value) +#define IO_SetLong(pContext, type, base, field, value) (base->field = value) +#define IO_GetLong(pContext, type, base, field) (base->field) + +#define IO_DisableInterrupt(h) CHNLSM_DisableInterrupt(h) +#define IO_EnableInterrupt(h) CHNLSM_EnableInterrupt(h) +#define IO_InterruptDSP(h) CHNLSM_InterruptDSP(h) +#define IO_InterruptDSP2(h, v) CHNLSM_InterruptDSP2(h, v) +#define IO_CALLDPC(h) CHNLSM_DPC(h) +#define IO_CALLISR(h, pFlag, pwMBRegVal) CHNLSM_ISR(h, pFlag, pwMBRegVal) + +/* + * ======== IO_CancelChnl ======== + * Purpose: + * Cancel IO on a given channel. + * Parameters: + * hIOMgr: IO Manager. + * ulChnl: Index of channel to cancel IO on. + * Returns: + * Requires: + * Valid hIOMgr. + * Ensures: + */ + extern void IO_CancelChnl(struct IO_MGR *hIOMgr, u32 ulChnl); + +/* + * ======== IO_DPC ======== + * Purpose: + * Deferred procedure call for shared memory channel driver ISR. Carries + * out the dispatch of I/O. + * Parameters: + * pRefData: Pointer to reference data registered via a call to + * DPC_Create(). + * Returns: + * Requires: + * Must not block. + * Must not acquire resources. + * All data touched must be locked in memory if running in kernel mode. + * Ensures: + * Non-preemptible (but interruptible). + */ + extern void IO_DPC(IN OUT void *pRefData); + +/* + * ======== IO_ISR ======== + * Purpose: + * Main interrupt handler for the shared memory WMD channel manager. + * Calls the WMD's CHNLSM_ISR to determine if this interrupt is ours, then + * schedules a DPC to dispatch I/O.. + * Parameters: + * pRefData: Pointer to the channel manager object for this board. + * Set in an initial call to ISR_Install(). + * Returns: + * TRUE if interrupt handled; FALSE otherwise. + * Requires: + * Must be in locked memory if executing in kernel mode. + * Must only call functions which are in locked memory if Kernel mode. + * Must only call asynchronous services. + * Interrupts are disabled and EOI for this interrupt has been sent. + * Ensures: + */ + extern bool IO_ISR(IN void *pRefData); + +/* + * ======== IO_RequestChnl ======== + * Purpose: + * Request I/O from the DSP. Sets flags in shared memory, then interrupts + * the DSP. + * Parameters: + * hIOMgr: IO manager handle. + * pChnl: Ptr to the channel requesting I/O. + * iMode: Mode of channel: {IO_INPUT | IO_OUTPUT}. + * Returns: + * Requires: + * pChnl != NULL + * Ensures: + */ + extern void IO_RequestChnl(struct IO_MGR *hIOMgr, + struct CHNL_OBJECT *pChnl, + u32 iMode, OUT u16 *pwMbVal); + +/* + * ======== IO_Schedule ======== + * Purpose: + * Schedule DPC for IO. + * Parameters: + * pIOMgr: Ptr to a I/O manager. + * Returns: + * Requires: + * pChnl != NULL + * Ensures: + */ + extern void IO_Schedule(struct IO_MGR *hIOMgr); + +/* + * DSP-DMA IO functions + */ + +/* + * ======== IO_DDMAInitChnlDesc ======== + * Purpose: + * Initialize DSP DMA channel descriptor. + * Parameters: + * hIOMgr: Handle to a I/O manager. + * uDDMAChnlId: DDMA channel identifier. + * uNumDesc: Number of buffer descriptors(equals # of IOReqs & + * Chirps) + * pDsp: Dsp address; + * Returns: + * Requires: + * uDDMAChnlId < DDMA_MAXDDMACHNLS + * uNumDesc > 0 + * pVa != NULL + * pDspPa != NULL + * + * Ensures: + */ + extern void IO_DDMAInitChnlDesc(struct IO_MGR *hIOMgr, u32 uDDMAChnlId, + u32 uNumDesc, void *pDsp); + +/* + * ======== IO_DDMAClearChnlDesc ======== + * Purpose: + * Clear DSP DMA channel descriptor. + * Parameters: + * hIOMgr: Handle to a I/O manager. + * uDDMAChnlId: DDMA channel identifier. + * Returns: + * Requires: + * uDDMAChnlId < DDMA_MAXDDMACHNLS + * Ensures: + */ + extern void IO_DDMAClearChnlDesc(struct IO_MGR *hIOMgr, + u32 uDDMAChnlId); + +/* + * ======== IO_DDMARequestChnl ======== + * Purpose: + * Request channel DSP-DMA from the DSP. Sets up SM descriptors and + * control fields in shared memory. + * Parameters: + * hIOMgr: Handle to a I/O manager. + * pChnl: Ptr to channel object + * pChirp: Ptr to channel i/o request packet. + * Returns: + * Requires: + * pChnl != NULL + * pChnl->cIOReqs > 0 + * pChirp != NULL + * Ensures: + */ + extern void IO_DDMARequestChnl(struct IO_MGR *hIOMgr, + struct CHNL_OBJECT *pChnl, + struct CHNL_IRP *pChirp, + OUT u16 *pwMbVal); + +/* + * Zero-copy IO functions + */ + +/* + * ======== IO_DDZCInitChnlDesc ======== + * Purpose: + * Initialize ZCPY channel descriptor. + * Parameters: + * hIOMgr: Handle to a I/O manager. + * uZId: zero-copy channel identifier. + * Returns: + * Requires: + * uDDMAChnlId < DDMA_MAXZCPYCHNLS + * hIOMgr != Null + * Ensures: + */ + extern void IO_DDZCInitChnlDesc(struct IO_MGR *hIOMgr, u32 uZId); + +/* + * ======== IO_DDZCClearChnlDesc ======== + * Purpose: + * Clear DSP ZC channel descriptor. + * Parameters: + * hIOMgr: Handle to a I/O manager. + * uChnlId: ZC channel identifier. + * Returns: + * Requires: + * hIOMgr is valid + * uChnlId < DDMA_MAXZCPYCHNLS + * Ensures: + */ + extern void IO_DDZCClearChnlDesc(struct IO_MGR *hIOMgr, u32 uChnlId); + +/* + * ======== IO_DDZCRequestChnl ======== + * Purpose: + * Request zero-copy channel transfer. Sets up SM descriptors and + * control fields in shared memory. + * Parameters: + * hIOMgr: Handle to a I/O manager. + * pChnl: Ptr to channel object + * pChirp: Ptr to channel i/o request packet. + * Returns: + * Requires: + * pChnl != NULL + * pChnl->cIOReqs > 0 + * pChirp != NULL + * Ensures: + */ + extern void IO_DDZCRequestChnl(struct IO_MGR *hIOMgr, + struct CHNL_OBJECT *pChnl, + struct CHNL_IRP *pChirp, + OUT u16 *pwMbVal); + +/* + * ======== IO_SHMsetting ======== + * Purpose: + * Sets the shared memory setting + * Parameters: + * hIOMgr: Handle to a I/O manager. + * desc: Shared memory type + * pArgs: Ptr to SHM setting + * Returns: + * Requires: + * hIOMgr != NULL + * pArgs != NULL + * Ensures: + */ + extern DSP_STATUS IO_SHMsetting(IN struct IO_MGR *hIOMgr, + IN enum SHM_DESCTYPE desc, + IN void *pArgs); + +/* + * Misc functions for the CHNL_IO shared memory library: + */ + +/* Maximum channel bufsize that can be used. */ + extern u32 IO_BufSize(struct IO_MGR *hIOMgr); + + extern u32 IO_ReadValue(struct WMD_DEV_CONTEXT *hDevContext, + u32 dwDSPAddr); + + extern void IO_WriteValue(struct WMD_DEV_CONTEXT *hDevContext, + u32 dwDSPAddr, u32 dwValue); + + extern u32 IO_ReadValueLong(struct WMD_DEV_CONTEXT *hDevContext, + u32 dwDSPAddr); + + extern void IO_WriteValueLong(struct WMD_DEV_CONTEXT *hDevContext, + u32 dwDSPAddr, u32 dwValue); + + extern void IO_OrSetValue(struct WMD_DEV_CONTEXT *hDevContext, + u32 dwDSPAddr, u32 dwValue); + + extern void IO_AndSetValue(struct WMD_DEV_CONTEXT *hDevContext, + u32 dwDSPAddr, u32 dwValue); + + extern void IO_IntrDSP2(IN struct IO_MGR *pIOMgr, IN u16 wMbVal); + +#endif /* IOSM_ */ diff --git a/arch/arm/plat-omap/include/bridge/iodefs.h b/arch/arm/plat-omap/include/bridge/iodefs.h new file mode 100644 index 0000000..1cadeaf --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/iodefs.h @@ -0,0 +1,45 @@ +/* + * bridge/inc/iodefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== iodefs.h ======== + * Description: + * System-wide channel objects and constants. + * + *! Revision History: + *! ================ + *! 07-Nov-2000 jeh Created. + */ + +#ifndef IODEFS_ +#define IODEFS_ + +#define IO_MAXIRQ 0xff /* Arbitrarily large number. */ + +/* IO Objects: */ + struct IO_MGR; + +/* IO manager attributes: */ + struct IO_ATTRS { + u8 bIRQ; /* Channel's I/O IRQ number. */ + bool fShared; /* TRUE if the IRQ is shareable. */ + u32 uWordSize; /* DSP Word size. */ + u32 dwSMBase; /* Physical base address of shared memory. */ + u32 uSMLength; /* Size (in bytes) of shared memory. */ + } ; + +#endif /* IODEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/isr.h b/arch/arm/plat-omap/include/bridge/isr.h new file mode 100644 index 0000000..3aceb09 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/isr.h @@ -0,0 +1,219 @@ +/* + * bridge/inc/isr.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== isr.h ======== + * Purpose: + * Interrupt services. + * + * Public Functions: + * ISR_Disable + * ISR_Exit + * ISR_GetStatus + * ISR_Init + * ISR_Install + * ISR_Restore + * ISR_SimulateInt + * ISR_Uninstall + * + * Notes: + * + *! Revision History: + *! ================ + *! 01-Mar-2004 vp: Added IVA related functions. + *! 06-Feb-2003 kc: Added ISR_MAILBOX1 (renamed from DSP_MAILBOX1). + *! 05-Nov-2001 kc: Added interrupt type param to ISR_Install. + *! 31-Jan-2000 rr: Comments modified after code review. + *! 29-Oct-1999 kc: Moved header files to within ifdefed 'extern "C"'. + *! 17-Sep-1997 gp: Added CFG_HOSTRES struct as argument to ISR_Install, thus + *! breaking backward compatibility with Ver. 1.0 mini drivers. + *! 18-Aug-1997 cr: Added explicit CDECL identifiers. + *! 03-Feb-1996 gp: Changed behaviour of ISR_SimulateInt. + *! 24-Jul-1996 gp: Created. + */ + +#ifndef ISR_ +#define ISR_ +#include +#include + +/* Interrupt Object handle: */ + struct ISR_IRQ; + +/* ISR install type (private) */ +#define ISR_MAILBOX1 0x00000080 /* Arbitrary value */ +#define ISR_MAILBOX2 0x00000081 + +/* Temporary until the baseport defines it */ +#define MAIL_U3_MPU_IRQ 34 +/* + * ======== ISR_PROC ======== + * Purpose: + * Routine to service an interrupt. + * Parameters: + * pRefData: Ptr to user data: passed in via ISR_Install. + * Returns: + * TRUE if the interrupt was handled; FALSE otherwise. + * Requires: + * ISR code must be in locked memory. + * All data touched must be locked. + * No resources should be acquired within the ISR. + * May only call asynchrounous services. + * Ensures: + * This routine must not affect the state of the physical PIC. + * (i.e.; don't send an EOI). + */ + typedef bool (CDECL *ISR_PROC) (void *pRefData); + +/* + * ======== ISR_Disable ======== + * Purpose: + * Turns off interrupts to begin a critical section of code. + * Not implemented in CE + * Parameters: + * pFlags: Location to store flags. + * Returns: + * Requires: + * Ensures: + */ + extern void CDECL ISR_Disable(OUT u32 *pFlags); + +/* + * ======== ISR_Exit ======== + * Purpose: + * Discontinue usage of the ISR module. + * Parameters: + * Returns: + * Requires: + * ISR_Init() was previously called. + * Ensures: + * Resources acquired in ISR_Init() are freed. + */ + extern void CDECL ISR_Exit(); + +/* + * ======== ISR_GetStatus ======== + * Purpose: + * Return platform specific status flags containing information about + * a virtualized IRQ. Used by clients for debugging only. + * Not implemented. + * Parameters: + * hIRQ: Interrupt object handle as returned by ISR_Install(). + * pdwFlags: Location to store status flags on output. + * Returns: + * DSP_SOK: Success; + * DSP_ENOTIMPL: Not implemented + * Requires: + * pdwFlags != NULL. + * Ensures: + */ + extern DSP_STATUS CDECL ISR_GetStatus(IN struct ISR_IRQ *hIRQ, + OUT u32 *pdwFlags); + +/* + * ======== ISR_Init ======== + * Purpose: + * Initialize the ISR module's private state. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * A requirement for each of the other public ISR functions. + */ + extern bool CDECL ISR_Init(); + +/* + * ======== ISR_Install ======== + * Purpose: + * Register an ISR for a given IRQ with the system's interrupt manager. + * Parameters: + * phIRQ: Ptr to store a handle to an interrupt object. + * pHostConfig: Ptr to a host resource structure, containing both + * interrupt and bus info. + * pfnISR: ISR function. See definition of ISR_PROC. + * dwIntrType: Type of interrupt. + * pRefData: Pointer to user-defined reference data. + * Returns: + * DSP_SOK: ISR installed. + * DSP_EPOINTER: phIRQ == NULL. + * DSP_EMEMORY: Insufficient memory. + * DSP_EFAIL: Error registering the ISR for the IRQ. + * Requires: + * pHostConfig is a valid pointer to assigned host resources; + * iIRQ number is valid for this (host) processor. + * See requirements for ISR_PROC. + * Ensures: + * DSP_SOK: ISR is installed, and the IRQ is unmasked. The ISR can be + * called at any time until ISR_Uninstall() is called for this + * IRQ. + * else: *phIRQ is set to NULL. + */ + extern DSP_STATUS CDECL ISR_Install(OUT struct ISR_IRQ **phIRQ, + IN CONST struct CFG_HOSTRES + *pHostConfig, + IN ISR_PROC pfnISR, + IN u32 dwIntrType, + IN void *pRefData); + +/* + * ======== ISR_Restore ======== + * Purpose: + * In CE, the client should use ISR_Install to restore the interrupt. + * Parameters: + * saveFlags: To save or not to save. + * Returns: + * Requires: + * Ensures: + */ + extern void CDECL ISR_Restore(IN u32 saveFlags); + +/* + * ======== ISR_SimulateInt ======== + * Purpose: + * Simulate a hardware interrupt. + * Parameters: + * hIRQ: Interrupt object handle as returned by ISR_Install(). + * Returns: + * DSP_SOK: Success; + * DSP_ENOTIMPL: Not yet implemented. + * DSP_EHANDLE: Invalid hIRQ. + * Requires: + * DSP_SOK: An interrupt handler must have been previously installed + * with ISR_Install(). + * Ensures: + * DSP_SOK: The ISR installed by ISR_Install() will be called, before + * or after this function returns. + */ + extern DSP_STATUS CDECL ISR_SimulateInt(IN struct ISR_IRQ *hIRQ); + +/* + * ======== ISR_Uninstall ======== + * Purpose: + * Deregister the ISR previously installed by ISR_Install(). + * Parameters: + * hIRQ: Handle to an IRQ object returned from ISR_Install(). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hIRQ. + * Requires: + * Ensures: + * (SUCCESS && hDPC is NULL) or DSP_EFAILED status + */ + extern DSP_STATUS CDECL ISR_Uninstall(IN struct ISR_IRQ *hIRQ); + +#endif /* ISR_ */ diff --git a/arch/arm/plat-omap/include/bridge/kfile.h b/arch/arm/plat-omap/include/bridge/kfile.h new file mode 100644 index 0000000..f5fe88a --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/kfile.h @@ -0,0 +1,216 @@ +/* + * bridge/inc/kfile.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== kfile.h ======== + * Purpose: + * Provide file I/O management capabilities. + * + * Public Functions: + * KFILE_Close + * KFILE_Exit + * KFILE_Init + * KFILE_Open + * KFILE_Read + * KFILE_Seek + * KFILE_Tell + * KFILE_Write + * + * Notes: + * The KFILE module is not like most of the other DSP/BIOS Bridge modules + * in that it doesn't return WSX_STATUS type values. Rather, it's + * prototypes are meant to match the stdio file prototypes + * (ie, fopen, fclose, etc.). + * + *! Revision History + *! ================ + *! 29-Oct-1999 kc: Clean up for code review. + *! 07-Jan-1998 cr: Clean up for code review. + *! 15-Aug-1997 cr: Added E_KFILE_ERROR for general error condition. + *! 04-Aug-1997 cr: Added explicit CDECL descriptions. + *! 11-Nov-1996 cr: Implemented changes based on code review. + *! 05-Nov-1996 cr: Cleaned up for code review. + *! 29-May-1996 gp: Added requirement that size != 0 in _Write() and _Read(). + *! 28-May-1996 mg: Changed return values for Read/Write. + *! 14-Dec-1995 cr: Created. + */ + +#ifndef KFILE_ +#define KFILE_ + +/* + * Constants for KFILE_Seek. Note that these MUST be the same definitions as + * those defined for fseek. + */ +#define KFILE_SEEK_SET 0x00 /* seek from beginning of file */ +#define KFILE_SEEK_CUR 0x01 /* seek from current position */ +#define KFILE_SEEK_END 0x02 /* seek from end of file */ + + struct KFILE_FileObj; + +/* + * ======== KFILE_Close ======== + * Purpose: + * This function closes a file's stream. + * Parameters: + * hFile: Handle of the file stream returned by KFILE_Open. + * Returns: + * E_KFILE_INVALIDHANDLE: bad handle. + * 0: success. + * E_KFILE_ERROR: unable to close specified handle. + * Requires: + * KFILE initialized. + * Ensures: + */ + extern s32 KFILE_Close(IN struct KFILE_FileObj *hFile); + +/* + * ======== KFILE_Exit ======== + * Purpose: + * Discontinue usage of module; free resources when reference count + * reaches 0. + * Parameters: + * Returns: + * Requires: + * KFILE initialized. + * Ensures: + * Resources used by module are freed when cRef reaches zero. + */ + extern void KFILE_Exit(); + +/* + * ======== KFILE_Init ======== + * Purpose: + * Initializes private state of KFILE module. + * Parameters: + * Returns: + * TRUE if success, else FALSE. + * Requires: + * Ensures: + * KFILE initialized. + */ + extern bool KFILE_Init(); + +/* + * ======== KFILE_Open ======== + * Purpose: + * Opens a file for use. + * Parameters: + * pszFileName: Full path to name of the file to open. + * pszMode: String containing open status. Only the first + * character of the string is examined, for either + * "r" (read) or "w" (write) mode. + * Returns: + * A valid file handle if success, else NULL. + * Requires: + * - KFILE initialized. + * - pszMode != NULL. + * - pszFileName != NULL. + * Ensures: + */ + extern struct KFILE_FileObj *KFILE_Open(IN CONST char *filename, + IN CONST char *mode); + +/* + * ======== KFILE_Read ======== + * Purpose: + * This function reads a specified number of bytes into a buffer. + * Parameters: + * pBuffer: Array to which the file data is copied. + * cSize: Number of characters in each object. + * cCount: Number of objects to read in. + * hFile: Handle of the file stream returned by KFILE_Open. + * Returns: + * E_KFILE_INVALIDHANDLE: bad file handle. + * E_KFILE_ERROR: general failure. + * > 0: success; # of objects read from file. + * Requires: + * KFILE initialized. + * pBuffer is a valid pointer. + * Ensures: + */ + extern s32 KFILE_Read(OUT void *buffer, + IN s32 size, IN s32 count, + IN struct KFILE_FileObj *hFile); + +/* + * ======== KFILE_Seek ======== + * Purpose: + * This function sets the file position indicator. NOTE: we don't + * support seeking beyond the boundaries of a file. + * Parameters: + * hFile: Handle of the file stream returned by KFILE_Open. + * offset: Number of bytes from the origin to move. + * origin: File reference point, one of the following values: + * KFILE_SEEK_SET: Seek from beginning of file. + * KFILE_SEEK_CUR: Seek from current position. + * KFILE_SEEK_END: Seek from end of file. + * Returns: + * 0: success. + * E_KFILE_INVALIDHANDLE: bad handle. + * E_KFILE_BADORIGIN: invalid origin paramater. + * E_KFILE_ERROR: general failure. + * Requires: + * KFILE initialized. + * Ensures: + */ + extern s32 KFILE_Seek(IN struct KFILE_FileObj *hFile, + IN s32 offset, IN s32 origin); + +/* + * ======== KFILE_Tell ======== + * Purpose: + * This function reports the current value of the position indicator. + * Parameters: + * hFile: Handle of the file stream returned by KFILE_Open. + * Return value: + * > 0: success; returns # of bytes the position indicator is from + * beginning of file. + * E_KFILE_ERROR: general failure. + * E_KFILE_INVALIDHANDLE: bad file handle. + * Requires: + * KFILE initialized. + * Ensures: + */ + extern s32 KFILE_Tell(IN struct KFILE_FileObj *hFile); + +/* + * ======== KFILE_Write ======== + * Purpose: + * This function writes a number of objects to the stream. + * Parameters: + * pBuffer: Array from which the file data is written. + * cSize: Number of characters in each object. + * cCount: Number of objects to write out. + * hFile: Handle of the file stream returned by KFILE_Open. + * Returns: + * E_KFILE_INVALIDHANDLE: bad file handle. + * E_KFILE_ERROR: general failure. + * > 0: success; # of objects written to file. + * Requires: + * KFILE initialized. + * pBuffer != NULL. + * Postcondition: + * The file position indicator is advanced by the number of + * characters written. + */ + extern s32 KFILE_Write(OUT void *buffer, + IN s32 size, + IN s32 count, + IN struct KFILE_FileObj *hFile); + +#endif /* KFILE_ */ diff --git a/arch/arm/plat-omap/include/bridge/ldr.h b/arch/arm/plat-omap/include/bridge/ldr.h new file mode 100644 index 0000000..7050be4 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/ldr.h @@ -0,0 +1,51 @@ +/* + * bridge/inc/ldr.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== ldr.h ======== + * Purpose: + * Provide module loading services and symbol export services. + * + * Public Functions: + * LDR_Exit + * LDR_FreeModule + * LDR_GetProcAddress + * LDR_Init + * LDR_LoadModule + * + * Notes: + * This service is meant to be used by modules of the DSP/BIOS Bridge + * class driver. + * + *! Revision History: + *! ================ + *! 22-Nov-1999 kc: Changes from code review. + *! 12-Nov-1999 kc: Removed declaration of unused loader object. + *! 29-Oct-1999 kc: Cleaned up for code review. + *! 12-Jan-1998 cr: Cleaned up for code review. + *! 04-Aug-1997 cr: Added explicit CDECL identifiers. + *! 11-Nov-1996 cr: Cleaned up for code review. + *! 16-May-1996 gp: Created. + */ + +#ifndef LDR_ +#define LDR_ + +/* Loader objects: */ + struct LDR_MODULE; + +#endif /* LDR_ */ diff --git a/arch/arm/plat-omap/include/bridge/list.h b/arch/arm/plat-omap/include/bridge/list.h new file mode 100644 index 0000000..5611270 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/list.h @@ -0,0 +1,296 @@ +/* + * bridge/inc/list.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== list.h ======== + * Purpose: + * Declarations of list management control structures and definitions + * of inline list management functions. + * + * Public Functions: + * LST_Create + * LST_Delete + * LST_Exit + * LST_First + * LST_GetHead + * LST_InitElem + * LST_Init + * LST_InsertBefore + * LST_IsEmpty + * LST_Next + * LST_PutTail + * LST_RemoveElem + * + * Notes: + * + *! Revision History + *! ================ + *! 10-Aug-2000 ag: Added LST_InsertBefore(). + *! 29-Oct-1999 kc: Cleaned up for code review. + *! 16-Aug-1997 cr: added explicit identifiers. + *! 10-Aug-1996 gp: Acquired from SMM for WinSPOX v.1.1; renamed identifiers. + *! 21-Oct-1994 dh4: Cleaned / commented for code review. + *! 08-Jun-1994 dh4: Converted to SPM (added extern "C"). + */ + +#ifndef LIST_ +#define LIST_ + +#include + +#define LST_IsEmpty(l) (((l)->head.next == &(l)->head)) + + struct LST_ELEM { + struct LST_ELEM *next; + struct LST_ELEM *prev; + struct LST_ELEM *self; + } ; + + struct LST_LIST { + struct LST_ELEM head; + } ; + +/* + * ======== LST_Create ======== + * Purpose: + * Allocates and initializes a circular list. + * Details: + * Uses portable MEM_Calloc() function to allocate a list containing + * a single element and initializes that element to indicate that it + * is the "end of the list" (i.e., the list is empty). + * An empty list is indicated by the "next" pointer in the element + * at the head of the list pointing to the head of the list, itself. + * Parameters: + * Returns: + * Pointer to beginning of created list (success) + * NULL --> Allocation failed + * Requires: + * LST initialized. + * Ensures: + * Notes: + * The created list contains a single element. This element is the + * "empty" element, because its "next" and "prev" pointers point at + * the same location (the element itself). + */ + extern struct LST_LIST *LST_Create(); + +/* + * ======== LST_Delete ======== + * Purpose: + * Removes a list by freeing its control structure's memory space. + * Details: + * Uses portable MEM_Free() function to deallocate the memory + * block pointed at by the input parameter. + * Parameters: + * pList: Pointer to list control structure of list to be deleted + * Returns: + * Void + * Requires: + * - LST initialized. + * - pList != NULL. + * Ensures: + * Notes: + * Must ONLY be used for empty lists, because it does not walk the + * chain of list elements. Calling this function on a non-empty list + * will cause a memory leak. + */ + extern void LST_Delete(IN struct LST_LIST *pList); + +/* + * ======== LST_Exit ======== + * Purpose: + * Discontinue usage of module; free resources when reference count + * reaches 0. + * Parameters: + * Returns: + * Requires: + * LST initialized. + * Ensures: + * Resources used by module are freed when cRef reaches zero. + */ + extern void LST_Exit(); + +/* + * ======== LST_First ======== + * Purpose: + * Returns a pointer to the first element of the list, or NULL if the list + * is empty. + * Parameters: + * pList: Pointer to list control structure. + * Returns: + * Pointer to first list element, or NULL. + * Requires: + * - LST initialized. + * - pList != NULL. + * Ensures: + */ + extern struct LST_ELEM *LST_First(IN struct LST_LIST *pList); + +/* + * ======== LST_GetHead ======== + * Purpose: + * Pops the head off the list and returns a pointer to it. + * Details: + * If the list is empty, returns NULL. + * Else, removes the element at the head of the list, making the next + * element the head of the list. + * The head is removed by making the tail element of the list point its + * "next" pointer at the next element after the head, and by making the + * "prev" pointer of the next element after the head point at the tail + * element. So the next element after the head becomes the new head of + * the list. + * Parameters: + * pList: Pointer to list control structure of list whose head + * element is to be removed + * Returns: + * Pointer to element that was at the head of the list (success) + * NULL No elements in list + * Requires: + * - head.self must be correctly set to &head. + * - LST initialized. + * - pList != NULL. + * Ensures: + * Notes: + * Because the tail of the list points forward (its "next" pointer) to + * the head of the list, and the head of the list points backward (its + * "prev" pointer) to the tail of the list, this list is circular. + */ + extern struct LST_ELEM *LST_GetHead(IN struct LST_LIST *pList); + +/* + * ======== LST_Init ======== + * Purpose: + * Initializes private state of LST module. + * Parameters: + * Returns: + * TRUE if initialized; FALSE otherwise. + * Requires: + * Ensures: + * LST initialized. + */ + extern bool LST_Init(); + +/* + * ======== LST_InitElem ======== + * Purpose: + * Initializes a list element to default (cleared) values + * Details: + * Parameters: + * pElem: Pointer to list element to be reset + * Returns: + * Requires: + * LST initialized. + * Ensures: + * Notes: + * This function must not be called to "reset" an element in the middle + * of a list chain -- that would break the chain. + * + */ + extern void LST_InitElem(IN struct LST_ELEM *pListElem); + +/* + * ======== LST_InsertBefore ======== + * Purpose: + * Insert the element before the existing element. + * Parameters: + * pList: Pointer to list control structure. + * pElem: Pointer to element in list to insert. + * pElemExisting: Pointer to existing list element. + * Returns: + * Requires: + * - LST initialized. + * - pList != NULL. + * - pElem != NULL. + * - pElemExisting != NULL. + * Ensures: + */ + extern void LST_InsertBefore(IN struct LST_LIST *pList, + IN struct LST_ELEM *pElem, + IN struct LST_ELEM *pElemExisting); + +/* + * ======== LST_Next ======== + * Purpose: + * Returns a pointer to the next element of the list, or NULL if the next + * element is the head of the list or the list is empty. + * Parameters: + * pList: Pointer to list control structure. + * pCurElem: Pointer to element in list to remove. + * Returns: + * Pointer to list element, or NULL. + * Requires: + * - LST initialized. + * - pList != NULL. + * - pCurElem != NULL. + * Ensures: + */ + extern struct LST_ELEM *LST_Next(IN struct LST_LIST *pList, + IN struct LST_ELEM *pCurElem); + +/* + * ======== LST_PutTail ======== + * Purpose: + * Adds the specified element to the tail of the list + * Details: + * Sets new element's "prev" pointer to the address previously held by + * the head element's prev pointer. This is the previous tail member of + * the list. + * Sets the new head's prev pointer to the address of the element. + * Sets next pointer of the previous tail member of the list to point to + * the new element (rather than the head, which it had been pointing at). + * Sets new element's next pointer to the address of the head element. + * Sets head's prev pointer to the address of the new element. + * Parameters: + * pList: Pointer to list control structure to which *pElem will be + * added + * pElem: Pointer to list element to be added + * Returns: + * Void + * Requires: + * *pElem and *pList must both exist. + * pElem->self = pElem before pElem is passed to this function. + * LST initialized. + * Ensures: + * Notes: + * Because the tail is always "just before" the head of the list (the + * tail's "next" pointer points at the head of the list, and the head's + * "prev" pointer points at the tail of the list), the list is circular. + * Warning: if pElem->self is not set beforehand, LST_GetHead() will + * return an erroneous pointer when it is called for this element. + */ + extern void LST_PutTail(IN struct LST_LIST *pList, + IN struct LST_ELEM *pListElem); + +/* + * ======== LST_RemoveElem ======== + * Purpose: + * Removes (unlinks) the given element from the list, if the list is not + * empty. Does not free the list element. + * Parameters: + * pList: Pointer to list control structure. + * pCurElem: Pointer to element in list to remove. + * Returns: + * Requires: + * - LST initialized. + * - pList != NULL. + * - pCurElem != NULL. + * Ensures: + */ +extern void LST_RemoveElem(IN struct LST_LIST *pList, + IN struct LST_ELEM *pCurElem); + +#endif /* LIST_ */ diff --git a/arch/arm/plat-omap/include/bridge/mbx_sh.h b/arch/arm/plat-omap/include/bridge/mbx_sh.h new file mode 100644 index 0000000..f0cbb85 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/mbx_sh.h @@ -0,0 +1,213 @@ +/* + * bridge/inc/mbx_sh.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== mbx_sh.h ======== + * Definitions for shared mailbox cmd/data values.(used on both + * the GPP and DSP sides). + * + * Bridge usage of OMAP mailbox 1 is determined by the "class" of the + * mailbox interrupt's cmd value received. The class value are defined + * as a bit (10 thru 15) being set. + * + * Note: Only 16 bits of each is used. Other 16 bit data reg available. + * + * 16 bit Mbx bit defns: + * + * A). Exception/Error handling (Module DEH) : class = 0. + * + * 15 10 0 + * --------------------------------- + * |0|0|0|0|0|0|x|x|x|x|x|x|x|x|x|x| + * --------------------------------- + * | (class) | (module specific) | + * + * + * + * B: DSP-DMA link driver channels (DDMA) : class = 1. + * + * 15 10 0 + * --------------------------------- + * |0|0|0|0|0|1|b|b|b|b|b|c|c|c|c|c| + * --------------------------------- + * | (class) | (module specific) | + * + * where b -> buffer index (32 DDMA buffers/chnl max) + * c -> channel Id (32 DDMA chnls max) + * + * + * + * + * C: Proc-copy link driver channels (PCPY) : class = 2. + * + * 15 10 0 + * --------------------------------- + * |0|0|0|0|1|0|x|x|x|x|x|x|x|x|x|x| + * --------------------------------- + * | (class) | (module specific) | + * + * + * D: Zero-copy link driver channels (DDZC) : class = 4. + * + * 15 10 0 + * --------------------------------- + * |0|0|0|1|0|0|x|x|x|x|x|c|c|c|c|c| + * --------------------------------- + * | (class) | (module specific) | + * + * where x -> not used + * c -> channel Id (32 ZCPY chnls max) + * + * + * E: Power management : class = 8. + * + * 15 10 0 + * --------------------------------- + * |0|0|1|0|0|0|x|x|x|x|x|c|c|c|c|c| + + * 0010 00xx xxxc cccc + * 0010 00nn pppp qqqq + * nn: + * 00 = reserved + * 01 = pwr state change + * 10 = opp pre-change + * 11 = opp post-change + * + * if nn = pwr state change: + * pppp = don't care + * qqqq: + * 0010 = hibernate + * 0010 0001 0000 0010 + * 0110 = retention + * 0010 0001 0000 0110 + * others reserved + * + * if nn = opp pre-change: + * pppp = current opp + * qqqq = next opp + * + * if nn = opp post-change: + * pppp = prev opp + * qqqq = current opp + * + * --------------------------------- + * | (class) | (module specific) | + * + * where x -> not used + * c -> Power management command + * + * + * + *! Revision History: + *! ================ + *! 19-Sep-2002 mr Added DEH reset const + *! 24-Apr-2002 sg Added more PM commands. + *! 04-Mar-2002 gv Added MBX_PM_CLASS + *! 22-Jan-2002 ag Bug fix in MBX_SETZCPYVAL(x) macro. + *! 21-Dec-2001 ag Added bit masks defns. + *! 17-Dec-2001 ag: created. + */ + +#ifndef _MBX_SH_H +#define _MBX_SH_H + +#define MBX_CLASS_MSK 0xFC00 /* Class bits are 10 thru 15 */ +#define MBX_VALUE_MSK 0x03FF /* Value is 0 thru 9 */ + +#define MBX_DEH_CLASS 0x0000 /* DEH owns Mbx INTR */ +#define MBX_DDMA_CLASS 0x0400 /* DSP-DMA link drvr chnls owns INTR */ +#define MBX_PCPY_CLASS 0x0800 /* PROC-COPY " */ +#define MBX_ZCPY_CLASS 0x1000 /* ZERO-COPY " */ +#define MBX_PM_CLASS 0x2000 /* Power Management */ +#define MBX_DBG_CLASS 0x4000 /* For debugging purpose */ + +/* + * Exception Handler codes + * Magic code used to determine if DSP signaled exception. + */ +#define MBX_DEH_BASE 0x0 +#define MBX_DEH_USERS_BASE 0x100 /* 256 */ +#define MBX_DEH_LIMIT 0x3FF /* 1023 */ +#define MBX_DEH_RESET 0x101 /* DSP RESET (DEH) */ +#define MBX_DEH_EMMU 0X103 /*DSP MMU FAULT RECOVERY*/ + +/* + * Link driver command/status codes. + */ +/* DSP-DMA */ +#define MBX_DDMA_NUMCHNLBITS 5 /* # chnl Id: # bits available */ +#define MBX_DDMA_CHNLSHIFT 0 /* # of bits to shift */ +#define MBX_DDMA_CHNLMSK 0x01F /* bits 0 thru 4 */ + +#define MBX_DDMA_NUMBUFBITS 5 /* buffer index: # of bits avail */ +#define MBX_DDMA_BUFSHIFT (MBX_DDMA_NUMCHNLBITS + MBX_DDMA_CHNLSHIFT) +#define MBX_DDMA_BUFMSK 0x3E0 /* bits 5 thru 9 */ + +/* Zero-Copy */ +#define MBX_ZCPY_NUMCHNLBITS 5 /* # chnl Id: # bits available */ +#define MBX_ZCPY_CHNLSHIFT 0 /* # of bits to shift */ +#define MBX_ZCPY_CHNLMSK 0x01F /* bits 0 thru 4 */ + +/* Power Management Commands */ +#define MBX_PM_DSPIDLE (MBX_PM_CLASS + 0x0) +#define MBX_PM_DSPWAKEUP (MBX_PM_CLASS + 0x1) +#define MBX_PM_EMERGENCYSLEEP (MBX_PM_CLASS + 0x2) +#define MBX_PM_SLEEPUNTILRESTART (MBX_PM_CLASS + 0x3) +#define MBX_PM_DSPGLOBALIDLE_OFF (MBX_PM_CLASS + 0x4) +#define MBX_PM_DSPGLOBALIDLE_ON (MBX_PM_CLASS + 0x5) +#define MBX_PM_SETPOINT_PRENOTIFY (MBX_PM_CLASS + 0x6) +#define MBX_PM_SETPOINT_POSTNOTIFY (MBX_PM_CLASS + 0x7) +#define MBX_PM_DSPRETN (MBX_PM_CLASS + 0x8) +#define MBX_PM_DSPRETENTION (MBX_PM_CLASS + 0x8) +#define MBX_PM_DSPHIBERNATE (MBX_PM_CLASS + 0x9) +#define MBX_PM_HIBERNATE_EN (MBX_PM_CLASS + 0xA) +#define MBX_PM_OPP_REQ (MBX_PM_CLASS + 0xB) +#define MBX_PM_OPP_CHG (MBX_PM_CLASS + 0xC) + +#define MBX_PM_TYPE_MASK 0x0300 +#define MBX_PM_TYPE_PWR_CHNG 0x0100 +#define MBX_PM_TYPE_OPP_PRECHNG 0x0200 +#define MBX_PM_TYPE_OPP_POSTCHNG 0x0300 +#define MBX_PM_TYPE_OPP_MASK 0x0300 +#define MBX_PM_OPP_PRECHNG (MBX_PM_CLASS | MBX_PM_TYPE_OPP_PRECHNG) +/* DSP to MPU */ +#define MBX_PM_OPP_CHNG(OPP) (MBX_PM_CLASS | MBX_PM_TYPE_OPP_PRECHNG | (OPP)) +#define MBX_PM_RET (MBX_PM_CLASS | MBX_PM_TYPE_PWR_CHNG | 0x0006) +#define MBX_PM_HIB (MBX_PM_CLASS | MBX_PM_TYPE_PWR_CHNG | 0x0002) +#define MBX_PM_OPP_1 0 +#define MBX_PM_OPP_2 1 +#define MBX_PM_OPP_3 2 +#define MBX_PM_OPP_4 3 +#define MBX_OLDOPP_EXTRACT(OPPMSG) ((0x00F0 & (OPPMSG)) >> 4) +#define MBX_NEWOPP_EXTRACT(OPPMSG) (0x000F & (OPPMSG)) +#define MBX_PREVOPP_EXTRACT(OPPMSG) ((0x00F0 & (OPPMSG)) >> 4) +#define MBX_CUROPP_EXTRACT(OPPMSG) (0x000F & (OPPMSG)) + +/* Bridge Debug Commands */ +#define MBX_DBG_SYSPRINTF (MBX_DBG_CLASS + 0x0) + +/* + * Useful macros + */ +/* DSP-DMA channel */ +#define MBX_SETDDMAVAL(x, y) (MBX_DDMA_CLASS | (x << MBX_DDMA_BUFSHIFT) | \ + (y << MBX_DDMA_CHNLSHIFT)) + +/* Zero-Copy channel */ +#define MBX_SETZCPYVAL(x) (MBX_ZCPY_CLASS | (x << MBX_ZCPY_CHNLSHIFT)) + +#endif /* _MBX_SH_H */ diff --git a/arch/arm/plat-omap/include/bridge/mem.h b/arch/arm/plat-omap/include/bridge/mem.h new file mode 100644 index 0000000..236268d --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/mem.h @@ -0,0 +1,340 @@ +/* + * bridge/inc/mem.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== mem.h ======== + * Purpose: + * Memory management and address mapping services for the DSP/BIOS Bridge + * class driver and mini-driver. + * + * Public Functions: + * MEM_Alloc + * MEM_AllocObject + * MEM_AllocPhysMem + * MEM_Calloc + * MEM_Exit + * MEM_FlushCache + * MEM_Free + * MEM_FreeObject + * MEM_FreePhysMem + * MEM_GetNumPages + * MEM_Init + * MEM_IsValidHandle + * MEM_LinearAddress + * MEM_PageLock + * MEM_PageUnlock + * MEM_UnMapLinearAddress + * MEM_VirtualToPhysical + * + * Notes: + * + *! Revision History: + *! ================ + *! 19-Apr-2004 sb: Added Alloc/Free PhysMem, FlushCache, VirtualToPhysical + *! 01-Sep-2001 ag: Cleaned up notes for MEM_LinearAddress() does not + *! require phys address to be page aligned! + *! 02-Dec-1999 rr: stdwin.h included for retail build + *! 12-Nov-1999 kc: Added warning about use of MEM_LinearAddress. + *! 29-Oct-1999 kc: Cleaned up for code review. + *! 10-Aug-1999 kc: Based on wsx-c18. + *! 07-Jan-1998 gp: Added MEM_AllocUMB and MEM_UMBFree for User Mapped Buffers + *! used by WMD_CHNL. + *! 23-Dec-1997 cr: Code review cleanup, removed dead Ring 3 code. + *! 04-Aug-1997 cr: Added explicit CDECL identifiers. + *! 01-Nov-1996 gp: Updated based on code review. + *! 04-Sep-1996 gp: Added MEM_PageLock() and MEM_PageUnlock() services. + *! 14-Aug-1996 mg: Added MEM_GetPhysAddr() and MEM_GetNumPages() + *! 25-Jul-1996 gp: Added MEM_IsValidHandle() macro. + *! 10-May-1996 gp: Added MEM_Calloc(). + *! 25-Apr-1996 gp: Added MEM_PhysicalAddress() + *! 17-Apr-1996 gp: Added MEM_Exit function; updated to latest naming standard. + *! 08-Apr-1996 gp: Created. + */ + +#ifndef MEM_ +#define MEM_ + +#include +#include + +/* + * ======== MEM_Alloc ======== + * Purpose: + * Allocate memory from the paged or non-paged pools. + * Parameters: + * cBytes: Number of bytes to allocate. + * type: Type of memory to allocate; one of: + * MEM_PAGED: Allocate from pageable memory. + * MEM_NONPAGED: Allocate from page locked memory. + * Returns: + * Pointer to a block of memory; + * NULL if memory couldn't be allocated, if cBytes == 0, or if type is + * not one of MEM_PAGED or MEM_NONPAGED. + * Requires: + * MEM initialized. + * Ensures: + * The returned pointer, if not NULL, points to a valid memory block of + * the size requested. + */ + extern void *MEM_Alloc(IN u32 cBytes, IN enum MEM_POOLATTRS type); + +/* + * ======== MEM_AllocObject ======== + * Purpose: + * Allocate an object, and set it's signature. + * Parameters: + * pObj: Pointer to the new object. + * Obj: Type of the object to allocate. + * Signature: Magic field value. Must be non-zero. + * Returns: + * Requires: + * Same requirements as MEM_Calloc(); and + * The object structure has a dwSignature field. The compiler ensures + * this requirement. + * Ensures: + * A subsequent call to MEM_IsValidHandle() will succeed for this object. + */ +#define MEM_AllocObject(pObj, Obj, Signature) \ +{ \ + pObj = MEM_Calloc(sizeof(Obj), MEM_NONPAGED); \ + if (pObj) { \ + pObj->dwSignature = Signature; \ + } \ +} + +/* ======== MEM_AllocPhysMem ======== + * Purpose: + * Allocate physically contiguous, uncached memory + * Parameters: + * cBytes: Number of bytes to allocate. + * ulAlign: Alignment Mask. + * pPhysicalAddress: Physical address of allocated memory. + * Returns: + * Pointer to a block of memory; + * NULL if memory couldn't be allocated, or if cBytes == 0. + * Requires: + * MEM initialized. + * Ensures: + * The returned pointer, if not NULL, points to a valid memory block of + * the size requested. Returned physical address refers to physical + * location of memory. + */ + extern void *MEM_AllocPhysMem(IN u32 cBytes, + IN u32 ulAlign, + OUT u32 *pPhysicalAddress); + +/* + * ======== MEM_Calloc ======== + * Purpose: + * Allocate zero-initialized memory from the paged or non-paged pools. + * Parameters: + * cBytes: Number of bytes to allocate. + * type: Type of memory to allocate; one of: + * MEM_PAGED: Allocate from pageable memory. + * MEM_NONPAGED: Allocate from page locked memory. + * Returns: + * Pointer to a block of zeroed memory; + * NULL if memory couldn't be allocated, if cBytes == 0, or if type is + * not one of MEM_PAGED or MEM_NONPAGED. + * Requires: + * MEM initialized. + * Ensures: + * The returned pointer, if not NULL, points to a valid memory block + * of the size requested. + */ + extern void *MEM_Calloc(IN u32 cBytes, IN enum MEM_POOLATTRS type); + +/* + * ======== MEM_Exit ======== + * Purpose: + * Discontinue usage of module; free resources when reference count + * reaches 0. + * Parameters: + * Returns: + * Requires: + * MEM is initialized. + * Ensures: + * Resources used by module are freed when cRef reaches zero. + */ + extern void MEM_Exit(); + +/* + * ======== MEM_FlushCache ======== + * Purpose: + * Performs system cache sync with discard + * Parameters: + * pMemBuf: Pointer to memory region to be flushed. + * pMemBuf: Size of the memory region to be flushed. + * Returns: + * Requires: + * MEM is initialized. + * Ensures: + * Cache is synchronized + */ + extern void MEM_FlushCache(void *pMemBuf, u32 cBytes, s32 FlushType); + +/* + * ======== MEM_Free ======== + * Purpose: + * Free the given block of system memory. + * Parameters: + * pMemBuf: Pointer to memory allocated by MEM_Calloc/Alloc(). + * Returns: + * Requires: + * MEM initialized. + * pMemBuf is a valid memory address returned by MEM_Calloc/Alloc(). + * Ensures: + * pMemBuf is no longer a valid pointer to memory. + */ + extern void MEM_Free(IN void *pMemBuf); + +/* + * ======== MEM_FreePhysMem ======== + * Purpose: + * Free the given block of physically contiguous memory. + * Parameters: + * pVirtualAddress: Pointer to virtual memory region allocated + * by MEM_AllocPhysMem(). + * pPhysicalAddress: Pointer to physical memory region allocated + * by MEM_AllocPhysMem(). + * cBytes: Size of the memory region allocated by MEM_AllocPhysMem(). + * Returns: + * Requires: + * MEM initialized. + * pVirtualAddress is a valid memory address returned by + * MEM_AllocPhysMem() + * Ensures: + * pVirtualAddress is no longer a valid pointer to memory. + */ + extern void MEM_FreePhysMem(void *pVirtualAddress, + u32 pPhysicalAddress, u32 cBytes); + +/* + * ======== MEM_FreeObject ======== + * Purpose: + * Utility macro to invalidate an object's signature, and deallocate it. + * Parameters: + * pObj: Pointer to the object to free. + * Returns: + * Requires: + * Same requirements as MEM_Free(). + * Ensures: + * A subsequent call to MEM_IsValidHandle() will fail for this object. + */ +#define MEM_FreeObject(pObj) \ +{ \ + pObj->dwSignature = 0x00; \ + MEM_Free(pObj); \ +} + +/* + * ======== MEM_GetNumPages ======== + * Purpose: + * Calculate the number of pages corresponding to the supplied buffer. + * Parameters: + * pAddr: Linear (virtual) address of the buffer. + * cBytes: Number of bytes in the buffer. + * Returns: + * Number of pages. + * Requires: + * MEM initialized. + * Ensures: + * If cBytes > 0, number of pages returned > 0. + */ + extern s32 MEM_GetNumPages(IN void *pAddr, IN u32 cBytes); + +/* + * ======== MEM_Init ======== + * Purpose: + * Initializes private state of MEM module. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * MEM initialized. + */ + extern bool MEM_Init(); + +/* + * ======== MEM_IsValidHandle ======== + * Purpose: + * Validate the object handle. + * Parameters: + * hObj: Handle to object created with MEM_AllocObject(). + * Sig: Expected signature u32. + * Returns: + * TRUE if handle is valid; FALSE otherwise. + * Requires: + * The object structure has a dwSignature field. Ensured by compiler. + * Ensures: + */ +#define MEM_IsValidHandle(hObj, Sig) \ + ((hObj != NULL) && (hObj->dwSignature == Sig)) + +/* + * ======== MEM_LinearAddress ======== + * Purpose: + * Get the linear address corresponding to the given physical address. + * Parameters: + * pPhysAddr: Physical address to be mapped. + * cBytes: Number of bytes in physical range to map. + * Returns: + * The corresponding linear address, or NULL if unsuccessful. + * Requires: + * MEM initialized. + * Ensures: + * Notes: + * If valid linear address is returned, be sure to call + * MEM_UnmapLinearAddress(). + */ +#define MEM_LinearAddress(pPhyAddr, cBytes) pPhyAddr + +/* + * ======== MEM_UnmapLinearAddress ======== + * Purpose: + * Unmap the linear address mapped in MEM_LinearAddress. + * Parameters: + * pBaseAddr: Ptr to mapped memory (as returned by MEM_LinearAddress()). + * Returns: + * Requires: + * - MEM initialized. + * - pBaseAddr is a valid linear address mapped in MEM_LinearAddress. + * Ensures: + * - pBaseAddr no longer points to a valid linear address. + */ +#define MEM_UnmapLinearAddress(pBaseAddr) + +/* + * ======== MEM_ExtPhysPoolInit ======== + * Purpose: + * Uses the physical memory chunk passed for internal consitent memory + * allocations. + * physical address based on the page frame address. + * Parameters: + * poolPhysBase starting address of the physical memory pool. + * poolSize size of the physical memory pool. + * Returns: + * none. + * Requires: + * - MEM initialized. + * - valid physical address for the base and size > 0 + */ + extern void MEM_ExtPhysPoolInit(IN u32 poolPhysBase, + IN u32 poolSize); + +#endif /* MEM_ */ diff --git a/arch/arm/plat-omap/include/bridge/memdefs.h b/arch/arm/plat-omap/include/bridge/memdefs.h new file mode 100644 index 0000000..066c8cd --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/memdefs.h @@ -0,0 +1,52 @@ +/* + * bridge/inc/memdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== memdefs.h ======== + * Purpose: + * Global MEM constants and types, shared between WSX, WCD, and WMD. + * + *! Revision History: + *! ================ + *! 28-Aug-2001 ag: Added MEM_[SET][GET]VIRTUALSEGID. + *! 10-Aug-1999 kc: Based on wsx-c18. + *! 15-Nov-1996 gp: Renamed from wsxmem.h and moved to kwinos. + *! 21-Aug-1996 cr: Created from mem.h. + */ + +#ifndef MEMDEFS_ +#define MEMDEFS_ + +/* Memory Pool Attributes: */ + enum MEM_POOLATTRS { + MEM_PAGED = 0, + MEM_NONPAGED = 1, + MEM_LARGEVIRTMEM = 2 + } ; + +/* + * MEM_VIRTUALSEGID is used by Node & Strm to access virtual address space in + * the correct client process context. + */ +#define MEM_SETVIRTUALSEGID 0x10000000 +#define MEM_GETVIRTUALSEGID 0x20000000 +#define MEM_MASKVIRTUALSEGID (MEM_SETVIRTUALSEGID | MEM_GETVIRTUALSEGID) + +#define TO_VIRTUAL_UNCACHED(x) x +#define INTREG_TO_VIRTUAL_UNCACHED(x) x + +#endif /* MEMDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/memry.h b/arch/arm/plat-omap/include/bridge/memry.h new file mode 100644 index 0000000..457e17f --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/memry.h @@ -0,0 +1,96 @@ +/* + * dspbridge/mp_driver/inc/memry.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== memry.h ======== + * Purpose: + * Functional interface for the memory manager, exported by the DSP + * system API DLL. This interface is not publicly documented. + * + * Public Functions: + * MEMRY_Alloc + * MEMRY_BindMem + * MEMRY_Calloc + * MEMRY_Free + * MEMRY_FreeVM + * MEMRY_LinearAddress + * MEMRY_ReserveVM + * MEMRY_PageLock + * MEMRY_PageUnlock + * MEMRY_UnMapLinearAddress + * + *! Revision History: + *! ================ + *! 01-Sep-2001 ag: Added MEMRY_[UnMap]LinearAddress. + *! 11-Oct-2000 ag: Added MEMRY_Reserve[Free]VM() & MEMRY_BindMem(). + *! 12-Nov-1999 kc: Updated for WinCE. + *! + */ + +#ifndef MEMRY_ +#define MEMRY_ + +#include + +#include + +/* + * MEMRY_[GET]SET]VIRTUALSEGID is used by Node & Strm to access virtual + * address space in the correct client process context. The virtual to + * physical mapping is done in the client process context. + */ +#define MEMRY_SETVIRTUALSEGID MEM_SETVIRTUALSEGID +#define MEMRY_GETVIRTUALSEGID MEM_GETVIRTUALSEGID +#define MEMRY_MASKVIRTUALSEGID MEM_MASKVIRTUALSEGID + +/* + * ======== MEMRY_LinearAddress ======== + * Purpose: + * Get the linear address corresponding to the given physical address. + * Parameters: + * pPhysAddr: Physical address to be mapped. + * cBytes: Number of bytes in physical range to map. + * Returns: + * The corresponding linear address, or NULL if unsuccessful. + * Requires: + * PhysAddr != 0 + * Ensures: + * Notes: + * If valid linear address is returned, be sure to call + * MEMRY_UnMapLinearAddress(). + */ + extern inline void *MEMRY_LinearAddress(void *pPhyAddr, u32 cBytes) + { + return pPhyAddr; + } + +/* + * ======== MEMRY_UnMapLinearAddress ======== + * Purpose: + * Unmap the linear address mapped in MEMRY_LinearAddress. + * Parameters: + * pBaseAddr: Ptr to mapped memory (as returned by MEMRY_LinearAddress()). + * Returns: + * Requires: + * - pBaseAddr is a valid linear address mapped in MEMRY_LinearAddress. + * Ensures: + * - pBaseAddr no longer points to a valid linear address. + */ + extern inline void MEMRY_UnMapLinearAddress(void *pBaseAddr) + { + } + +#endif /* MEMRY_ */ diff --git a/arch/arm/plat-omap/include/bridge/mgr.h b/arch/arm/plat-omap/include/bridge/mgr.h new file mode 100644 index 0000000..ac17d7a --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/mgr.h @@ -0,0 +1,234 @@ +/* + * bridge/inc/mgr.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== mgr.h ======== + * Description: + * This is the Class driver RM module interface. + * + * Public Functions: + * MGR_Create + * MGR_Destroy + * MGR_EnumNodeInfo + * MGR_EnumProcessorInfo + * MGR_Exit + * MGR_GetDCDHandle + * MGR_Init + * + * Notes: + * + *! Revision History: + *! ================ + *! 15-Oct-2002 kc: Removed legacy PERF definitions. + *! 11-Jul-2001 jeh Added CFG_HDEVNODE parameter to MGR_Create(). + *! 22-Nov-2000 kc: Added MGR_GetPerfData for acquiring PERF stats. + *! 03-Nov-2000 rr: Added MGR_GetDCDHandle. Modified after code review. + *! 25-Sep-2000 rr: Updated to Version 0.9 + *! 14-Aug-2000 rr: Cleaned up. + *! 07-Aug-2000 rr: MGR_Create does the job of Loading DCD Dll. + *! 27-Jul-2000 rr: Updated to ver 0.8 of DSPAPI(types). + *! 20-Jun-2000 rr: Created. + */ + +#ifndef MGR_ +#define MGR_ + +#include + +#define MAX_EVENTS 32 + +/* + * ======== MGR_WaitForBridgeEvents ======== + * Purpose: + * Block on any Bridge event(s) + * Parameters: + * aNotifications : array of pointers to notification objects. + * uCount : number of elements in above array + * puIndex : index of signaled event object + * uTimeout : timeout interval in milliseocnds + * Returns: + * DSP_SOK : Success. + * DSP_ETIMEOUT : Wait timed out. *puIndex is undetermined. + * Details: + */ + + DSP_STATUS MGR_WaitForBridgeEvents(struct DSP_NOTIFICATION + **aNotifications, + u32 uCount, OUT u32 *puIndex, + u32 uTimeout); + +/* + * ======== MGR_Create ======== + * Purpose: + * Creates the Manager Object. This is done during the driver loading. + * There is only one Manager Object in the DSP/BIOS Bridge. + * Parameters: + * phMgrObject: Location to store created MGR Object handle. + * hDevNode: Device object as known to Windows system. + * Returns: + * DSP_SOK: Success + * DSP_EMEMORY: Failed to Create the Object + * DSP_EFAIL: General Failure + * Requires: + * MGR Initialized (cRefs > 0 ) + * phMgrObject != NULL. + * Ensures: + * DSP_SOK: *phMgrObject is a valid MGR interface to the device. + * MGR Object stores the DCD Manager Handle. + * MGR Object stored in the Regsitry. + * !DSP_SOK: MGR Object not created + * Details: + * DCD Dll is loaded and MGR Object stores the handle of the DLL. + */ + extern DSP_STATUS MGR_Create(OUT struct MGR_OBJECT **hMgrObject, + struct CFG_DEVNODE *hDevNode); + +/* + * ======== MGR_Destroy ======== + * Purpose: + * Destroys the MGR object. Called upon driver unloading. + * Parameters: + * hMgrObject: Handle to Manager object . + * Returns: + * DSP_SOK: Success. + * DCD Manager freed; MGR Object destroyed; + * MGR Object deleted from the Registry. + * DSP_EFAIL: Failed to destroy MGR Object + * Requires: + * MGR Initialized (cRefs > 0 ) + * hMgrObject is a valid MGR handle . + * Ensures: + * DSP_SOK: MGR Object destroyed and hMgrObject is Invalid MGR + * Handle. + */ + extern DSP_STATUS MGR_Destroy(struct MGR_OBJECT *hMgrObject); + +/* + * ======== MGR_EnumNodeInfo ======== + * Purpose: + * Enumerate and get configuration information about nodes configured + * in the node database. + * Parameters: + * uNode: The node index (base 0). + * pNDBProps: Ptr to the DSP_NDBPROPS structure for output. + * uNDBPropsSize: Size of the DSP_NDBPROPS structure. + * puNumNodes: Location where the number of nodes configured + * in the database will be returned. + * Returns: + * DSP_SOK: Success. + * DSP_EINVALIDARG: Parameter uNode is > than the number of nodes. + * configutred in the system + * DSP_ECHANGEDURINGENUM: During Enumeration there has been a change in + * the number of nodes configured or in the + * the properties of the enumerated nodes. + * DSP_EFAIL: Failed to querry the Node Data Base + * Requires: + * pNDBPROPS is not null + * uNDBPropsSize >= sizeof(DSP_NDBPROPS) + * puNumNodes is not null + * MGR Initialized (cRefs > 0 ) + * Ensures: + * SUCCESS on successful retreival of data and *puNumNodes > 0 OR + * DSP_FAILED && *puNumNodes == 0. + * Details: + */ + extern DSP_STATUS MGR_EnumNodeInfo(u32 uNode, + OUT struct DSP_NDBPROPS *pNDBProps, + u32 uNDBPropsSize, + OUT u32 *puNumNodes); + +/* + * ======== MGR_EnumProcessorInfo ======== + * Purpose: + * Enumerate and get configuration information about available DSP + * processors + * Parameters: + * uProcessor: The processor index (zero-based). + * pProcessorInfo: Ptr to the DSP_PROCESSORINFO structure . + * uProcessorInfoSize: Size of DSP_PROCESSORINFO structure. + * puNumProcs: Location where the number of DSPs configured + * in the database will be returned + * Returns: + * DSP_SOK: Success. + * DSP_EINVALIDARG: Parameter uProcessor is > than the number of + * DSP Processors in the system. + * DSP_EFAIL: Failed to querry the Node Data Base + * Requires: + * pProcessorInfo is not null + * puNumProcs is not null + * uProcessorInfoSize >= sizeof(DSP_PROCESSORINFO) + * MGR Initialized (cRefs > 0 ) + * Ensures: + * SUCCESS on successful retreival of data and *puNumProcs > 0 OR + * DSP_FAILED && *puNumProcs == 0. + * Details: + */ + extern DSP_STATUS MGR_EnumProcessorInfo(u32 uProcessor, + OUT struct DSP_PROCESSORINFO * + pProcessorInfo, + u32 uProcessorInfoSize, + OUT u32 *puNumProcs); +/* + * ======== MGR_Exit ======== + * Purpose: + * Decrement reference count, and free resources when reference count is + * 0. + * Parameters: + * Returns: + * Requires: + * MGR is initialized. + * Ensures: + * When reference count == 0, MGR's private resources are freed. + */ + extern void CDECL MGR_Exit(); + +/* + * ======== MGR_GetDCDHandle ======== + * Purpose: + * Retrieves the MGR handle. Accessor Function + * Parameters: + * hMGRHandle: Handle to the Manager Object + * phDCDHandle: Ptr to receive the DCD Handle. + * Returns: + * DSP_SOK: Sucess + * DSP_EFAIL: Failure to get the Handle + * Requires: + * MGR is initialized. + * phDCDHandle != NULL + * Ensures: + * DSP_SOK and *phDCDHandle != NULL || + * DSP_EFAIL and *phDCDHandle == NULL + */ + extern DSP_STATUS CDECL MGR_GetDCDHandle(IN struct MGR_OBJECT + *hMGRHandle, + OUT u32 *phDCDHandle); + +/* + * ======== MGR_Init ======== + * Purpose: + * Initialize MGR's private state, keeping a reference count on each + * call. Intializes the DCD. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * TRUE: A requirement for the other public MGR functions. + */ + extern bool CDECL MGR_Init(); + +#endif /* MGR_ */ diff --git a/arch/arm/plat-omap/include/bridge/mgrpriv.h b/arch/arm/plat-omap/include/bridge/mgrpriv.h new file mode 100644 index 0000000..55e0d48 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/mgrpriv.h @@ -0,0 +1,55 @@ +/* + * bridge/inc/mgrpriv.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== mgrpriv.h ======== + * Description: + * Global MGR constants and types, shared by PROC, MGR, and WCD. + * + *! Revision History: + *! ================ + *! 29-July-2001 ag: added MGR_PROCESSOREXTINFO. + *! 05-July-2000 rr: Created + */ + +#ifndef MGRPRIV_ +#define MGRPRIV_ + +/* + * OMAP1510 specific + */ +#define MGR_MAXTLBENTRIES 32 + +/* RM MGR Object */ + struct MGR_OBJECT; + + struct MGR_TLBENTRY { + u32 ulDspVirt; /* DSP virtual address */ + u32 ulGppPhys; /* GPP physical address */ + } ; + +/* + * The DSP_PROCESSOREXTINFO structure describes additional extended + * capabilities of a DSP processor not exposed to user. + */ + struct MGR_PROCESSOREXTINFO { + struct DSP_PROCESSORINFO tyBasic; /* user processor info */ + /* private dsp mmu entries */ + struct MGR_TLBENTRY tyTlb[MGR_MAXTLBENTRIES]; + } ; + +#endif /* MGRPRIV_ */ diff --git a/arch/arm/plat-omap/include/bridge/msg.h b/arch/arm/plat-omap/include/bridge/msg.h new file mode 100644 index 0000000..91b325e --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/msg.h @@ -0,0 +1,106 @@ +/* + * bridge/inc/msg.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== msg.h ======== + * Description: + * DSP/BIOS Bridge MSG Module. + * + * Public Functions: + * MSG_Create + * MSG_Delete + * MSG_Exit + * MSG_Init + * + * Notes: + * + *! Revision History: + *! ================= + *! 17-Nov-2000 jeh Removed MSG_Get, MSG_Put, MSG_CreateQueue, + *! MSG_DeleteQueue, and MSG_RegisterNotify, since these + *! are now part of mini-driver. + *! 12-Sep-2000 jeh Created. + */ + +#ifndef MSG_ +#define MSG_ + +#include +#include + +/* + * ======== MSG_Create ======== + * Purpose: + * Create an object to manage message queues. Only one of these objects + * can exist per device object. The MSG manager must be created before + * the IO Manager. + * Parameters: + * phMsgMgr: Location to store MSG manager handle on output. + * hDevObject: The device object. + * msgCallback: Called whenever an RMS_EXIT message is received. + * Returns: + * Requires: + * MSG_Init() called. + * phMsgMgr != NULL. + * hDevObject != NULL. + * msgCallback != NULL. + * Ensures: + */ + extern DSP_STATUS MSG_Create(OUT struct MSG_MGR **phMsgMgr, + struct DEV_OBJECT *hDevObject, + MSG_ONEXIT msgCallback); + +/* + * ======== MSG_Delete ======== + * Purpose: + * Delete a MSG manager allocated in MSG_Create(). + * Parameters: + * hMsgMgr: Handle returned from MSG_Create(). + * Returns: + * Requires: + * MSG_Init() called. + * Valid hMsgMgr. + * Ensures: + */ + extern void MSG_Delete(struct MSG_MGR *hMsgMgr); + +/* + * ======== MSG_Exit ======== + * Purpose: + * Discontinue usage of MSG module. + * Parameters: + * Returns: + * Requires: + * MSG_Init() successfully called before. + * Ensures: + * Any resources acquired in MSG_Init() will be freed when last MSG + * client calls MSG_Exit(). + */ + extern void MSG_Exit(); + +/* + * ======== MSG_Init ======== + * Purpose: + * Initialize the MSG module. + * Parameters: + * Returns: + * TRUE if initialization succeeded, FALSE otherwise. + * Ensures: + */ + extern bool MSG_Init(); + +#endif /* MSG_ */ diff --git a/arch/arm/plat-omap/include/bridge/msgdefs.h b/arch/arm/plat-omap/include/bridge/msgdefs.h new file mode 100644 index 0000000..4e62335 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/msgdefs.h @@ -0,0 +1,43 @@ +/* + * bridge/inc/msgdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== msgdefs.h ======== + * Description: + * Global MSG constants and types. + * + *! Revision History + *! ================ + *! 09-May-2001 jeh Removed MSG_TODSP, MSG_FROMDSP. + *! 17-Nov-2000 jeh Added MSGMGR_SIGNATURE. + *! 12-Sep-2000 jeh Created. + */ + +#ifndef MSGDEFS_ +#define MSGDEFS_ + +#define MSGMGR_SIGNATURE 0x4d47534d /* "MGSM" */ + +/* MSG Objects: */ + struct MSG_MGR; + struct MSG_QUEUE; + +/* Function prototype for callback to be called on RMS_EXIT message received */ + typedef void(CDECL *MSG_ONEXIT) (HANDLE h, s32 nStatus); + +#endif /* MSGDEFS_ */ + diff --git a/arch/arm/plat-omap/include/bridge/nldr.h b/arch/arm/plat-omap/include/bridge/nldr.h new file mode 100644 index 0000000..69e4bfa --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/nldr.h @@ -0,0 +1,81 @@ +/* + * bridge/inc/nldr.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== nldr.h ======== + * + * Description: + * DSP/BIOS Bridge dynamic loader interface. See the file dldrdefs.h + * for a description of these functions. + * + * Public Functions: + * NLDR_Allocate + * NLDR_Create + * NLDR_Delete + * NLDR_Exit + * NLDR_Free + * NLDR_GetFxnAddr + * NLDR_Init + * NLDR_Load + * NLDR_Unload + * + * Notes: + * + *! Revision History + *! ================ + *! 31-Jul-2002 jeh Removed function header comments. + *! 17-Apr-2002 jeh Created. + */ + +#include +#include +#include +#include +#include + +#ifndef NLDR_ +#define NLDR_ + + extern DSP_STATUS NLDR_Allocate(struct NLDR_OBJECT *hNldr, + void *pPrivRef, + IN CONST struct DCD_NODEPROPS + *pNodeProps, + OUT struct NLDR_NODEOBJECT **phNldrNode, + IN bool *pfPhaseSplit); + + extern DSP_STATUS NLDR_Create(OUT struct NLDR_OBJECT **phNldr, + struct DEV_OBJECT *hDevObject, + IN CONST struct NLDR_ATTRS *pAttrs); + + extern void NLDR_Delete(struct NLDR_OBJECT *hNldr); + extern void NLDR_Exit(void); + extern void NLDR_Free(struct NLDR_NODEOBJECT *hNldrNode); + + extern DSP_STATUS NLDR_GetFxnAddr(struct NLDR_NODEOBJECT *hNldrNode, + char *pstrFxn, u32 *pulAddr); + + extern DSP_STATUS NLDR_GetRmmManager(struct NLDR_OBJECT *hNldrObject, + OUT struct RMM_TargetObj + **phRmmMgr); + + extern bool NLDR_Init(void); + extern DSP_STATUS NLDR_Load(struct NLDR_NODEOBJECT *hNldrNode, + enum NLDR_PHASE phase); + extern DSP_STATUS NLDR_Unload(struct NLDR_NODEOBJECT *hNldrNode, + enum NLDR_PHASE phase); + +#endif /* NLDR_ */ diff --git a/arch/arm/plat-omap/include/bridge/nldrdefs.h b/arch/arm/plat-omap/include/bridge/nldrdefs.h new file mode 100644 index 0000000..09cd70c --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/nldrdefs.h @@ -0,0 +1,307 @@ +/* + * bridge/inc/nldrdefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2008 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== nldrdefs.h ======== + * Description: + * Global Dynamic + static/overlay Node loader (NLDR) constants and types. + * + *! Revision History + *! ================ + *! 07-Apr-2003 map Consolidated dldrdefs.h into nldrdefs.h + *! 05-Aug-2002 jeh Created. + */ + +#ifndef NLDRDEFS_ +#define NLDRDEFS_ + +#include +#include + +#define NLDR_MAXPATHLENGTH 255 +/* NLDR Objects: */ + struct NLDR_OBJECT; + struct NLDR_NODEOBJECT; + +/* + * ======== NLDR_LOADTYPE ======== + * Load types for a node. Must match values in node.h55. + */ + enum NLDR_LOADTYPE { + NLDR_STATICLOAD, /* Linked in base image, not overlay */ + NLDR_DYNAMICLOAD, /* Dynamically loaded node */ + NLDR_OVLYLOAD /* Linked in base image, overlay node */ + } ; + +/* + * ======== NLDR_OVLYFXN ======== + * Causes code or data to be copied from load address to run address. This + * is the "COD_WRITEFXN" that gets passed to the DBLL_Library and is used as + * the ZL write function. + * + * Parameters: + * pPrivRef: Handle to identify the node. + * ulDspRunAddr: Run address of code or data. + * ulDspLoadAddr: Load address of code or data. + * ulNumBytes: Number of (GPP) bytes to copy. + * nMemSpace: RMS_CODE or RMS_DATA. + * Returns: + * ulNumBytes: Success. + * 0: Failure. + * Requires: + * Ensures: + */ + typedef u32(CDECL *NLDR_OVLYFXN) (void *pPrivRef, u32 ulDspRunAddr, + u32 ulDspLoadAddr, + u32 ulNumBytes, u32 nMemSpace); + +/* + * ======== NLDR_WRITEFXN ======== + * Write memory function. Used for dynamic load writes. + * Parameters: + * pPrivRef: Handle to identify the node. + * ulDspAddr: Address of code or data. + * pBuf: Code or data to be written + * ulNumBytes: Number of (GPP) bytes to write. + * nMemSpace: DBLL_DATA or DBLL_CODE. + * Returns: + * ulNumBytes: Success. + * 0: Failure. + * Requires: + * Ensures: + */ + typedef u32(CDECL *NLDR_WRITEFXN) (void *pPrivRef, + u32 ulDspAddr, void *pBuf, + u32 ulNumBytes, u32 nMemSpace); + +/* + * ======== NLDR_ATTRS ======== + * Attributes passed to NLDR_Create function. + */ + struct NLDR_ATTRS { + NLDR_OVLYFXN pfnOvly; + NLDR_WRITEFXN pfnWrite; + u16 usDSPWordSize; + u16 usDSPMauSize; + } ; + +/* + * ======== NLDR_PHASE ======== + * Indicates node create, delete, or execute phase function. + */ + enum NLDR_PHASE { + NLDR_CREATE, + NLDR_DELETE, + NLDR_EXECUTE, + NLDR_NOPHASE + } ; + +/* + * Typedefs of loader functions imported from a DLL, or defined in a + * function table. + */ + +/* + * ======== NLDR_Allocate ======== + * Allocate resources to manage the loading of a node on the DSP. + * + * Parameters: + * hNldr: Handle of loader that will load the node. + * pPrivRef: Handle to identify the node. + * pNodeProps: Pointer to a DCD_NODEPROPS for the node. + * phNldrNode: Location to store node handle on output. This handle + * will be passed to NLDR_Load/NLDR_Unload. + * pfPhaseSplit: pointer to boolean variable referenced in node.c + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory on GPP. + * Requires: + * NLDR_Init() called. + * Valid hNldr. + * pNodeProps != NULL. + * phNldrNode != NULL. + * Ensures: + * DSP_SOK: IsValidNode(*phNldrNode). + * error: *phNldrNode == NULL. + */ + typedef DSP_STATUS(*NLDR_ALLOCATEFXN) (struct NLDR_OBJECT *hNldr, + void *pPrivRef, + IN CONST struct DCD_NODEPROPS + *pNodeProps, + OUT struct NLDR_NODEOBJECT + **phNldrNode, + OUT bool *pfPhaseSplit); + +/* + * ======== NLDR_Create ======== + * Create a loader object. This object handles the loading and unloading of + * create, delete, and execute phase functions of nodes on the DSP target. + * + * Parameters: + * phNldr: Location to store loader handle on output. + * hDevObject: Device for this processor. + * pAttrs: Loader attributes. + * Returns: + * DSP_SOK: Success; + * DSP_EMEMORY: Insufficient memory for requested resources. + * Requires: + * NLDR_Init() called. + * phNldr != NULL. + * hDevObject != NULL. + * pAttrs != NULL. + * Ensures: + * DSP_SOK: Valid *phNldr. + * error: *phNldr == NULL. + */ + typedef DSP_STATUS(*NLDR_CREATEFXN) (OUT struct NLDR_OBJECT **phNldr, + struct DEV_OBJECT *hDevObject, + IN CONST struct NLDR_ATTRS + *pAttrs); + +/* + * ======== NLDR_Delete ======== + * Delete the NLDR loader. + * + * Parameters: + * hNldr: Node manager object. + * Returns: + * Requires: + * NLDR_Init() called. + * Valid hNldr. + * Ensures: + * hNldr invalid + */ + typedef void(*NLDR_DELETEFXN) (struct NLDR_OBJECT *hNldr); + +/* + * ======== NLDR_Exit ======== + * Discontinue usage of NLDR module. + * + * Parameters: + * Returns: + * Requires: + * NLDR_Init() successfully called before. + * Ensures: + * Any resources acquired in NLDR_Init() will be freed when last NLDR + * client calls NLDR_Exit(). + */ + typedef void(*NLDR_EXITFXN) (); + +/* + * ======== NLDR_Free ======== + * Free resources allocated in NLDR_Allocate. + * + * Parameters: + * hNldrNode: Handle returned from NLDR_Allocate(). + * Returns: + * Requires: + * NLDR_Init() called. + * Valid hNldrNode. + * Ensures: + */ + typedef void(*NLDR_FREEFXN) (struct NLDR_NODEOBJECT *hNldrNode); + +/* + * ======== NLDR_GetFxnAddr ======== + * Get address of create, delete, or execute phase function of a node on + * the DSP. + * + * Parameters: + * hNldrNode: Handle returned from NLDR_Allocate(). + * pstrFxn: Name of function. + * pulAddr: Location to store function address. + * Returns: + * DSP_SOK: Success. + * DSP_ESYMBOL: Address of function not found. + * Requires: + * NLDR_Init() called. + * Valid hNldrNode. + * pulAddr != NULL; + * pstrFxn != NULL; + * Ensures: + */ + typedef DSP_STATUS(*NLDR_GETFXNADDRFXN) (struct NLDR_NODEOBJECT + *hNldrNode, + char *pstrFxn, u32 *pulAddr); + +/* + * ======== NLDR_Init ======== + * Initialize the NLDR module. + * + * Parameters: + * Returns: + * TRUE if initialization succeeded, FALSE otherwise. + * Ensures: + */ + typedef bool(*NLDR_INITFXN) (); + +/* + * ======== NLDR_Load ======== + * Load create, delete, or execute phase function of a node on the DSP. + * + * Parameters: + * hNldrNode: Handle returned from NLDR_Allocate(). + * phase: Type of function to load (create, delete, or execute). + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory on GPP. + * DSP_EOVERLAYMEMORY: Can't overlay phase because overlay memory + * is already in use. + * DSP_EDYNLOAD: Failure in dynamic loader library. + * DSP_EFWRITE: Failed to write phase's code or date to target. + * Requires: + * NLDR_Init() called. + * Valid hNldrNode. + * Ensures: + */ + typedef DSP_STATUS(*NLDR_LOADFXN) (struct NLDR_NODEOBJECT *hNldrNode, + enum NLDR_PHASE phase); + +/* + * ======== NLDR_Unload ======== + * Unload create, delete, or execute phase function of a node on the DSP. + * + * Parameters: + * hNldrNode: Handle returned from NLDR_Allocate(). + * phase: Node function to unload (create, delete, or execute). + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory on GPP. + * Requires: + * NLDR_Init() called. + * Valid hNldrNode. + * Ensures: + */ + typedef DSP_STATUS(*NLDR_UNLOADFXN) (struct NLDR_NODEOBJECT *hNldrNode, + enum NLDR_PHASE phase); + +/* + * ======== NLDR_FXNS ======== + */ + struct NLDR_FXNS { + NLDR_ALLOCATEFXN pfnAllocate; + NLDR_CREATEFXN pfnCreate; + NLDR_DELETEFXN pfnDelete; + NLDR_EXITFXN pfnExit; + NLDR_FREEFXN pfnFree; + NLDR_GETFXNADDRFXN pfnGetFxnAddr; + NLDR_INITFXN pfnInit; + NLDR_LOADFXN pfnLoad; + NLDR_UNLOADFXN pfnUnload; + } ; + +#endif /* NLDRDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/node.h b/arch/arm/plat-omap/include/bridge/node.h new file mode 100644 index 0000000..6aaf2bf --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/node.h @@ -0,0 +1,619 @@ +/* + * bridge/inc/node.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== node.h ======== + * Description: + * DSP/BIOS Bridge Node Manager. + * + * Public Functions: + * NODE_Allocate + * NODE_AllocMsgBuf + * NODE_ChangePriority + * NODE_Connect + * NODE_Create + * NODE_CreateMgr + * NODE_Delete + * NODE_DeleteMgr + * NODE_EnumNodes + * NODE_Exit + * NODE_FreeMsgBuf + * NODE_GetAttr + * NODE_GetMessage + * NODE_GetProcessor + * NODE_Init + * NODE_OnExit + * NODE_Pause + * NODE_PutMessage + * NODE_RegisterNotify + * NODE_Run + * NODE_Terminate + * + * Notes: + * + *! Revision History: + *! ================= + *! 23-Apr-2001 jeh Updated with code review changes. + *! 16-Jan-2001 jeh Added DSP_ESYMBOL, DSP_EUUID to return codes. + *! 17-Nov-2000 jeh Added NODE_OnExit(). + *! 27-Oct-2000 jeh Added timeouts to NODE_GetMessage, NODE_PutMessage. + *! 12-Oct-2000 jeh Changed NODE_EnumNodeInfo to NODE_EnumNodes. Removed + *! NODE_RegisterAllNodes(). + *! 07-Sep-2000 jeh Changed type HANDLE in NODE_RegisterNotify to + *! DSP_HNOTIFICATION. Added DSP_STRMATTR param to + *! NODE_Connect(). Removed NODE_GetMessageStream(). + *! 17-Jul-2000 jeh Updated function header descriptions. + *! 19-Jun-2000 jeh Created. + */ + +#ifndef NODE_ +#define NODE_ + +#include + +#include +#include +#include + +/* + * ======== NODE_Allocate ======== + * Purpose: + * Allocate GPP resources to manage a node on the DSP. + * Parameters: + * hProcessor: Handle of processor that is allocating the node. + * pNodeId: Pointer to a DSP_UUID for the node. + * pArgs: Optional arguments to be passed to the node. + * pAttrIn: Optional pointer to node attributes (priority, + * timeout...) + * phNode: Location to store node handle on output. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory on GPP. + * DSP_EUUID: Node UUID has not been registered. + * DSP_ESYMBOL: iAlg functions not found for a DAIS node. + * DSP_ERANGE: pAttrIn != NULL and pAttrIn->iPriority out of + * range. + * DSP_EFAIL: A failure occured, unable to allocate node. + * DSP_EWRONGSTATE: Proccessor is not in the running state. + * Requires: + * NODE_Init() called. + * hProcessor != NULL. + * pNodeId != NULL. + * phNode != NULL. + * Ensures: + * DSP_SOK: IsValidNode(*phNode). + * error: *phNode == NULL. + */ + extern DSP_STATUS NODE_Allocate(struct PROC_OBJECT *hProcessor, + IN CONST struct DSP_UUID *pNodeId, + OPTIONAL IN CONST struct DSP_CBDATA + *pArgs, + OPTIONAL IN CONST struct DSP_NODEATTRIN + *pAttrIn, + OUT struct NODE_OBJECT **phNode); + +/* + * ======== NODE_AllocMsgBuf ======== + * Purpose: + * Allocate and Prepare a buffer whose descriptor will be passed to a + * Node within a (DSP_MSG)message + * Parameters: + * hNode: The node handle. + * uSize: The size of the buffer to be allocated. + * pAttr: Pointer to a DSP_BUFFERATTR structure. + * pBuffer: Location to store the address of the allocated + * buffer on output. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid node handle. + * DSP_EMEMORY: Insufficent memory. + * DSP_EFAIL: General Failure. + * DSP_ESIZE: Invalid Size. + * Requires: + * NODE_Init() called. + * pBuffer != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_AllocMsgBuf(struct NODE_OBJECT *hNode, + u32 uSize, + OPTIONAL struct DSP_BUFFERATTR + *pAttr, + OUT u8 **pBuffer); + +/* + * ======== NODE_ChangePriority ======== + * Purpose: + * Change the priority of an allocated node. + * Parameters: + * hNode: Node handle returned from NODE_Allocate. + * nPriority: New priority level to set node's priority to. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ERANGE: nPriority is out of range. + * DSP_ENODETYPE: The specified node is not a task node. + * DSP_EWRONGSTATE: Node is not in the NODE_ALLOCATED, NODE_PAUSED, + * or NODE_RUNNING state. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * DSP_ERESTART: A critical error has occurred and the DSP is + * being restarted. + * DSP_EFAIL: Unable to change node's runtime priority level. + * Requires: + * NODE_Init() called. + * Ensures: + * DSP_SOK && (Node's current priority == nPriority) + */ + extern DSP_STATUS NODE_ChangePriority(struct NODE_OBJECT *hNode, + s32 nPriority); + +/* + * ======== NODE_CloseOrphans ======== + * Purpose: + * Delete all nodes whose owning processor is being destroyed. + * Parameters: + * hNodeMgr: Node manager object. + * hProc: Handle to processor object being destroyed. + * Returns: + * DSP_SOK: Success. + * DSP_EFAIL: Unable to delete all nodes belonging to hProc. + * Requires: + * Valid hNodeMgr. + * hProc != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_CloseOrphans(struct NODE_MGR *hNodeMgr, + struct PROC_OBJECT *hProc); + +/* + * ======== NODE_Connect ======== + * Purpose: + * Connect two nodes on the DSP, or a node on the DSP to the GPP. In the + * case that the connnection is being made between a node on the DSP and + * the GPP, one of the node handles (either hNode1 or hNode2) must be + * the constant NODE_HGPPNODE. + * Parameters: + * hNode1: Handle of first node to connect to second node. If + * this is a connection from the GPP to hNode2, hNode1 + * must be the constant NODE_HGPPNODE. Otherwise, hNode1 + * must be a node handle returned from a successful call + * to Node_Allocate(). + * hNode2: Handle of second node. Must be either NODE_HGPPNODE + * if this is a connection from DSP node to GPP, or a + * node handle returned from a successful call to + * NODE_Allocate(). + * uStream1: Output stream index on first node, to be connected + * to second node's input stream. Value must range from + * 0 <= uStream1 < number of output streams. + * uStream2: Input stream index on second node. Value must range + * from 0 <= uStream2 < number of input streams. + * pAttrs: Stream attributes (NULL ==> use defaults). + * pConnParam: A pointer to a DSP_CBDATA structure that defines + * connection parameter for device nodes to pass to DSP + * side. + * If the value of this parameter is NULL, then this API + * behaves like DSPNode_Connect. This parameter will have + * length of the string and the null terminated string in + * DSP_CBDATA struct. This can be extended in future tp + * pass binary data. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode1 or hNode2. + * DSP_EMEMORY: Insufficient host memory. + * DSP_EVALUE: A stream index parameter is invalid. + * DSP_EALREADYCONNECTED: A connection already exists for one of the + * indices uStream1 or uStream2. + * DSP_EWRONGSTATE: Either hNode1 or hNode2 is not in the + * NODE_ALLOCATED state. + * DSP_ENOMORECONNECTIONS: No more connections available. + * DSP_EFAIL: Attempt to make an illegal connection (eg, + * Device node to device node, or device node to + * GPP), the two nodes are on different DSPs. + * Requires: + * NODE_Init() called. + * Ensures: + */ + extern DSP_STATUS NODE_Connect(struct NODE_OBJECT *hNode1, + u32 uStream1, + struct NODE_OBJECT *hNode2, + u32 uStream2, + OPTIONAL IN struct DSP_STRMATTR *pAttrs, + OPTIONAL IN struct DSP_CBDATA + *pConnParam); + +/* + * ======== NODE_Create ======== + * Purpose: + * Create a node on the DSP by remotely calling the node's create + * function. If necessary, load code that contains the node's create + * function. + * Parameters: + * hNode: Node handle returned from NODE_Allocate(). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ESYMBOL: Create function not found in the COFF file. + * DSP_EWRONGSTATE: Node is not in the NODE_ALLOCATED state. + * DSP_EMEMORY: Memory allocation failure on the DSP. + * DSP_ETASK: Unable to create node's task or process on the DSP. + * DSP_ESTREAM: Stream creation failure on the DSP. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * DSP_EUSER1-16: A user-defined failure occurred on the DSP. + * DSP_EFAIL: A failure occurred, unable to create node. + * Requires: + * NODE_Init() called. + * Ensures: + */ + extern DSP_STATUS NODE_Create(struct NODE_OBJECT *hNode); + +/* + * ======== NODE_CreateMgr ======== + * Purpose: + * Create a NODE Manager object. This object handles the creation, + * deletion, and execution of nodes on the DSP target. The NODE Manager + * also maintains a pipe map of used and available node connections. + * Each DEV object should have exactly one NODE Manager object. + * + * Parameters: + * phNodeMgr: Location to store node manager handle on output. + * hDevObject: Device for this processor. + * Returns: + * DSP_SOK: Success; + * DSP_EMEMORY: Insufficient memory for requested resources. + * DSP_EFAIL: General failure. + * Requires: + * NODE_Init() called. + * phNodeMgr != NULL. + * hDevObject != NULL. + * Ensures: + * DSP_SOK: Valide *phNodeMgr. + * error: *phNodeMgr == NULL. + */ + extern DSP_STATUS NODE_CreateMgr(OUT struct NODE_MGR **phNodeMgr, + struct DEV_OBJECT *hDevObject); + +/* + * ======== NODE_Delete ======== + * Purpose: + * Delete resources allocated in NODE_Allocate(). If the node was + * created, delete the node on the DSP by remotely calling the node's + * delete function. Loads the node's delete function if necessary. + * GPP side resources are freed after node's delete function returns. + * Parameters: + * hNode: Node handle returned from NODE_Allocate(). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * DSP_EDELETE: A deletion failure occurred. + * DSP_EUSER1-16: Node specific failure occurred on the DSP. + * DSP_EFAIL: A failure occurred in deleting the node. + * DSP_ESYMBOL: Delete function not found in the COFF file. + * Requires: + * NODE_Init() called. + * Ensures: + * DSP_SOK: hNode is invalid. + */ + extern DSP_STATUS NODE_Delete(struct NODE_OBJECT *hNode); + +/* + * ======== NODE_DeleteMgr ======== + * Purpose: + * Delete the NODE Manager. + * Parameters: + * hNodeMgr: Node manager object. + * Returns: + * DSP_SOK: Success. + * Requires: + * NODE_Init() called. + * Valid hNodeMgr. + * Ensures: + */ + extern DSP_STATUS NODE_DeleteMgr(struct NODE_MGR *hNodeMgr); + +/* + * ======== NODE_EnumNodes ======== + * Purpose: + * Enumerate the nodes currently allocated for the DSP. + * Parameters: + * hNodeMgr: Node manager returned from NODE_CreateMgr(). + * aNodeTab: Array to copy node handles into. + * uNodeTabSize: Number of handles that can be written to aNodeTab. + * puNumNodes: Location where number of node handles written to + * aNodeTab will be written. + * puAllocated: Location to write total number of allocated nodes. + * Returns: + * DSP_SOK: Success. + * DSP_ESIZE: aNodeTab is too small to hold all node handles. + * Requires: + * Valid hNodeMgr. + * aNodeTab != NULL || uNodeTabSize == 0. + * puNumNodes != NULL. + * puAllocated != NULL. + * Ensures: + * - (DSP_ESIZE && *puNumNodes == 0) + * - || (DSP_SOK && *puNumNodes <= uNodeTabSize) && + * (*puAllocated == *puNumNodes) + */ + extern DSP_STATUS NODE_EnumNodes(struct NODE_MGR *hNodeMgr, + IN DSP_HNODE *aNodeTab, + u32 uNodeTabSize, + OUT u32 *puNumNodes, + OUT u32 *puAllocated); + +/* + * ======== NODE_Exit ======== + * Purpose: + * Discontinue usage of NODE module. + * Parameters: + * Returns: + * Requires: + * NODE_Init() successfully called before. + * Ensures: + * Any resources acquired in NODE_Init() will be freed when last NODE + * client calls NODE_Exit(). + */ + extern void NODE_Exit(); + +/* + * ======== NODE_FreeMsgBuf ======== + * Purpose: + * Free a message buffer previously allocated with NODE_AllocMsgBuf. + * Parameters: + * hNode: The node handle. + * pBuffer: (Address) Buffer allocated by NODE_AllocMsgBuf. + * pAttr: Same buffer attributes passed to NODE_AllocMsgBuf. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid node handle. + * DSP_EFAIL: Failure to free the buffer. + * Requires: + * NODE_Init() called. + * pBuffer != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_FreeMsgBuf(struct NODE_OBJECT *hNode, + IN u8 *pBuffer, + OPTIONAL struct DSP_BUFFERATTR + *pAttr); + +/* + * ======== NODE_GetAttr ======== + * Purpose: + * Copy the current attributes of the specified node into a DSP_NODEATTR + * structure. + * Parameters: + * hNode: Node object allocated from NODE_Allocate(). + * pAttr: Pointer to DSP_NODEATTR structure to copy node's + * attributes. + * uAttrSize: Size of pAttr. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * Requires: + * NODE_Init() called. + * pAttr != NULL. + * Ensures: + * DSP_SOK: *pAttrs contains the node's current attributes. + */ + extern DSP_STATUS NODE_GetAttr(struct NODE_OBJECT *hNode, + OUT struct DSP_NODEATTR *pAttr, + u32 uAttrSize); + +/* + * ======== NODE_GetMessage ======== + * Purpose: + * Retrieve a message from a node on the DSP. The node must be either a + * message node, task node, or XDAIS socket node. + * If a message is not available, this function will block until a + * message is available, or the node's timeout value is reached. + * Parameters: + * hNode: Node handle returned from NODE_Allocate(). + * pMessage: Pointer to DSP_MSG structure to copy the + * message into. + * uTimeout: Timeout in milliseconds to wait for message. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ENODETYPE: Cannot retrieve messages from this type of node. + * DSP_ETIMEOUT: Timeout occurred and no message is available. + * DSP_EFAIL: Error occurred while trying to retrieve a message. + * Requires: + * NODE_Init() called. + * pMessage != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_GetMessage(struct NODE_OBJECT *hNode, + OUT struct DSP_MSG *pMessage, + u32 uTimeout); + +/* + * ======== NODE_GetNldrObj ======== + * Purpose: + * Retrieve the Nldr manager + * Parameters: + * hNodeMgr: Node Manager + * phNldrObj: Pointer to a Nldr manager handle + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * Ensures: + */ + extern DSP_STATUS NODE_GetNldrObj(struct NODE_MGR *hNodeMgr, + OUT struct NLDR_OBJECT **phNldrObj); + +/* + * ======== NODE_Init ======== + * Purpose: + * Initialize the NODE module. + * Parameters: + * Returns: + * TRUE if initialization succeeded, FALSE otherwise. + * Ensures: + */ + extern bool NODE_Init(); + +/* + * ======== NODE_OnExit ======== + * Purpose: + * Gets called when RMS_EXIT is received for a node. PROC needs to pass + * this function as a parameter to MSG_Create(). This function then gets + * called by the mini-driver when an exit message for a node is received. + * Parameters: + * hNode: Handle of the node that the exit message is for. + * nStatus: Return status of the node's execute phase. + * Returns: + * Ensures: + */ + void NODE_OnExit(struct NODE_OBJECT *hNode, s32 nStatus); + +/* + * ======== NODE_Pause ======== + * Purpose: + * Suspend execution of a node currently running on the DSP. + * Parameters: + * hNode: Node object representing a node currently + * running on the DSP. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ENODETYPE: Node is not a task or socket node. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * DSP_EWRONGSTSATE: Node is not in NODE_RUNNING state. + * DSP_EFAIL: Failed to pause node. + * Requires: + * NODE_Init() called. + * Ensures: + */ + extern DSP_STATUS NODE_Pause(struct NODE_OBJECT *hNode); + +/* + * ======== NODE_PutMessage ======== + * Purpose: + * Send a message to a message node, task node, or XDAIS socket node. + * This function will block until the message stream can accommodate + * the message, or a timeout occurs. The message will be copied, so Msg + * can be re-used immediately after return. + * Parameters: + * hNode: Node handle returned by NODE_Allocate(). + * pMsg: Location of message to be sent to the node. + * uTimeout: Timeout in msecs to wait. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ENODETYPE: Messages can't be sent to this type of node. + * DSP_ETIMEOUT: Timeout occurred before message could be set. + * DSP_EWRONGSTATE: Node is in invalid state for sending messages. + * DSP_EFAIL: Unable to send message. + * Requires: + * NODE_Init() called. + * pMsg != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_PutMessage(struct NODE_OBJECT *hNode, + IN CONST struct DSP_MSG *pMsg, + u32 uTimeout); + +/* + * ======== NODE_RegisterNotify ======== + * Purpose: + * Register to be notified on specific events for this node. + * Parameters: + * hNode: Node handle returned by NODE_Allocate(). + * uEventMask: Mask of types of events to be notified about. + * uNotifyType: Type of notification to be sent. + * hNotification: Handle to be used for notification. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_EMEMORY: Insufficient memory on GPP. + * DSP_EVALUE: uEventMask is invalid. + * DSP_ENOTIMPL: Notification type specified by uNotifyType is not + * supported. + * Requires: + * NODE_Init() called. + * hNotification != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_RegisterNotify(struct NODE_OBJECT *hNode, + u32 uEventMask, u32 uNotifyType, + struct DSP_NOTIFICATION + *hNotification); + +/* + * ======== NODE_Run ======== + * Purpose: + * Start execution of a node's execute phase, or resume execution of + * a node that has been suspended (via NODE_Pause()) on the DSP. Load + * the node's execute function if necessary. + * Parameters: + * hNode: Node object representing a node currently + * running on the DSP. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ENODETYPE: hNode doesn't represent a message, task or dais + * socket node. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * DSP_EWRONGSTSATE: Node is not in NODE_PAUSED or NODE_CREATED state. + * DSP_EFAIL: Unable to start or resume execution. + * DSP_ESYMBOL: Execute function not found in the COFF file. + * Requires: + * NODE_Init() called. + * Ensures: + */ + extern DSP_STATUS NODE_Run(struct NODE_OBJECT *hNode); + +/* + * ======== NODE_Terminate ======== + * Purpose: + * Signal a node running on the DSP that it should exit its execute + * phase function. + * Parameters: + * hNode: Node object representing a node currently + * running on the DSP. + * pStatus: Location to store execute-phase function return + * value (DSP_EUSER1-16). + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ETIMEOUT: A timeout occurred before the DSP responded. + * DSP_ENODETYPE: Type of node specified cannot be terminated. + * DSP_EWRONGSTATE: Operation not valid for the current node state. + * DSP_EFAIL: Unable to terminate the node. + * Requires: + * NODE_Init() called. + * pStatus != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_Terminate(struct NODE_OBJECT *hNode, + OUT DSP_STATUS *pStatus); + + + +/* + * ======== NODE_GetUUIDProps ======== + * Purpose: + * Fetch Node properties given the UUID + * Parameters: + * + */ + extern DSP_STATUS NODE_GetUUIDProps(DSP_HPROCESSOR hProcessor, + IN CONST struct DSP_UUID *pNodeId, + OUT struct DSP_NDBPROPS + *pNodeProps); + +#endif /* NODE_ */ diff --git a/arch/arm/plat-omap/include/bridge/nodedefs.h b/arch/arm/plat-omap/include/bridge/nodedefs.h new file mode 100644 index 0000000..a943bd1 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/nodedefs.h @@ -0,0 +1,40 @@ +/* + * bridge/inc/nodedefs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== nodedefs.h ======== + * Description: + * Global NODE constants and types, shared by PROCESSOR, NODE, and DISP. + * + *! Revision History + *! ================ + *! 23-Apr-2001 jeh Removed NODE_MGRATTRS. + *! 21-Sep-2000 jeh Removed NODE_TYPE enum. + *! 17-Jul-2000 jeh Changed order of node types to match rms_sh.h. + *! 20-Jun-2000 jeh Created. + */ + +#ifndef NODEDEFS_ +#define NODEDEFS_ + +#define NODE_SUSPENDEDPRI -1 + +/* NODE Objects: */ + struct NODE_MGR; + struct NODE_OBJECT; + +#endif /* NODEDEFS_ */ diff --git a/arch/arm/plat-omap/include/bridge/nodepriv.h b/arch/arm/plat-omap/include/bridge/nodepriv.h new file mode 100644 index 0000000..51cf0bc --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/nodepriv.h @@ -0,0 +1,237 @@ +/* + * bridge/inc/nodepriv.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + +/* + * ======== nodepriv.h ======== + * Description: + * Private node header shared by NODE and DISP. + * + * Public Functions: + * NODE_GetChannelId + * NODE_GetStrmMgr + * NODE_GetTimeout + * NODE_GetType + * NODE_GetLoadType + * + *! Revision History + *! ================ + *! 19-Nov-2002 map Added NODE_GetLoadType + *! 13-Feb-2002 jeh Added uSysStackSize to NODE_TASKARGS. + *! 23-Apr-2001 jeh Removed unused typedefs, defines. + *! 10-Oct-2000 jeh Added alignment to NODE_STRMDEF. + *! 20-Jun-2000 jeh Created. + */ + +#ifndef NODEPRIV_ +#define NODEPRIV_ + +#include +#include +#include + +/* DSP address of node environment structure */ + typedef u32 NODE_ENV; + +/* + * Node create structures + */ + +/* Message node */ + struct NODE_MSGARGS { + u32 uMaxMessages; /* Max # of simultaneous messages for node */ + u32 uSegid; /* Segment for allocating message buffers */ + u32 uNotifyType; /* Notify type (SEM_post, SWI_post, etc.) */ + u32 uArgLength; /* Length in 32-bit words of arg data block */ + u8 *pData; /* Argument data for node */ + } ; + + struct NODE_STRMDEF { + u32 uBufsize; /* Size of buffers for SIO stream */ + u32 uNumBufs; /* max # of buffers in SIO stream at once */ + u32 uSegid; /* Memory segment id to allocate buffers */ + u32 uTimeout; /* Timeout for blocking SIO calls */ + u32 uAlignment; /* Buffer alignment */ + char *szDevice; /* Device name for stream */ + } ; + +/* Task node */ + struct NODE_TASKARGS { + struct NODE_MSGARGS msgArgs; + s32 nPriority; + u32 uStackSize; + u32 uSysStackSize; + u32 uStackSeg; + u32 uDSPHeapResAddr; /* DSP virtual heap address */ + u32 uDSPHeapAddr; /* DSP virtual heap address */ + u32 uHeapSize; /* Heap size */ + u32 uGPPHeapAddr; /* GPP virtual heap address */ + u32 uProfileID; /* Profile ID */ + u32 uNumInputs; + u32 uNumOutputs; + u32 ulDaisArg; /* Address of iAlg object */ + struct NODE_STRMDEF *strmInDef; + struct NODE_STRMDEF *strmOutDef; + } ; + +/* + * ======== NODE_CREATEARGS ======== + */ + struct NODE_CREATEARGS { + union { + struct NODE_MSGARGS msgArgs; + struct NODE_TASKARGS taskArgs; + } asa; + } ; + +/* + * Node types: Message node, task node, xDAIS socket node, and + * device node. _NODE_GPP is used when defining a stream connection + * between a task or socket node and the GPP. + * + * ~~~~~~~~~~~~~~ + * TO DO: + * Clean up when Node Manager uses only one critical section. + * ~~~~~~~~~~~~~~ + */ + enum NODE_TYPE { + _NODE_DEVICE = NODE_DEVICE, + _NODE_TASK = NODE_TASK, + _NODE_DAISSOCKET = NODE_DAISSOCKET, + _NODE_MESSAGE = NODE_MESSAGE, + NODE_GPP + } ; + +/* + * ======== NODE_STATE ======== + * Internal node states. + */ + enum NODE_STATE { + _NODE_ALLOCATED = NODE_ALLOCATED, + _NODE_CREATED = NODE_CREATED, + _NODE_RUNNING = NODE_RUNNING, + _NODE_PAUSED = NODE_PAUSED, + _NODE_DONE = NODE_DONE, + NODE_CREATING, + NODE_STARTING, + NODE_PAUSING, + NODE_TERMINATING, + NODE_DELETING, + } ; + +/* + * ======== NODE_GetChannelId ======== + * Purpose: + * Get the channel index reserved for a stream connection between the + * host and a node. This index is reserved when NODE_Connect() is called + * to connect the node with the host. This index should be passed to + * the CHNL_Open function when the stream is actually opened. + * Parameters: + * hNode: Node object allocated from NODE_Allocate(). + * uDir: Input (DSP_TONODE) or output (DSP_FROMNODE). + * uIndex: Stream index. + * pulId: Location to store channel index. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * DSP_ENODETYPE: Not a task or DAIS socket node. + * DSP_EVALUE: The node's stream corresponding to uIndex and uDir + * is not a stream to or from the host. + * Requires: + * NODE_Init() called. + * Valid uDir. + * pulId != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_GetChannelId(struct NODE_OBJECT *hNode, + u32 uDir, + u32 uIndex, OUT u32 *pulId); + +/* + * ======== NODE_GetStrmMgr ======== + * Purpose: + * Get the STRM manager for a node. + * Parameters: + * hNode: Node allocated with NODE_Allocate(). + * phStrmMgr: Location to store STRM manager on output. + * Returns: + * DSP_SOK: Success. + * DSP_EHANDLE: Invalid hNode. + * Requires: + * phStrmMgr != NULL. + * Ensures: + */ + extern DSP_STATUS NODE_GetStrmMgr(struct NODE_OBJECT *hNode, + struct STRM_MGR **phStrmMgr); + +/* + * ======== NODE_GetTimeout ======== + * Purpose: + * Get the timeout value of a node. + * Parameters: + * hNode: Node allocated with NODE_Allocate(), or DSP_HGPPNODE. + * Returns: + * Node's timeout value. + * Requires: + * Valid hNode. + * Ensures: + */ + extern u32 NODE_GetTimeout(struct NODE_OBJECT *hNode); + +/* + * ======== NODE_GetType ======== + * Purpose: + * Get the type (device, message, task, or XDAIS socket) of a node. + * Parameters: + * hNode: Node allocated with NODE_Allocate(), or DSP_HGPPNODE. + * Returns: + * Node type: NODE_DEVICE, NODE_TASK, NODE_XDAIS, or NODE_GPP. + * Requires: + * Valid hNode. + * Ensures: + */ + extern enum NODE_TYPE NODE_GetType(struct NODE_OBJECT *hNode); + +/* + * ======== GetNodeInfo ======== + * Purpose: + * Get node information without holding semaphore. + * Parameters: + * hNode: Node allocated with NODE_Allocate(), or DSP_HGPPNODE. + * Returns: + * Node info: priority, device owner, no. of streams, execution state + * NDB properties. + * Requires: + * Valid hNode. + * Ensures: + */ + extern void GetNodeInfo(struct NODE_OBJECT *hNode, + struct DSP_NODEINFO *pNodeInfo); + +/* + * ======== NODE_GetLoadType ======== + * Purpose: + * Get the load type (dynamic, overlay, static) of a node. + * Parameters: + * hNode: Node allocated with NODE_Allocate(), or DSP_HGPPNODE. + * Returns: + * Node type: NLDR_DYNAMICLOAD, NLDR_OVLYLOAD, NLDR_STATICLOAD + * Requires: + * Valid hNode. + * Ensures: + */ + extern enum NLDR_LOADTYPE NODE_GetLoadType(struct NODE_OBJECT *hNode); + +#endif /* NODEPRIV_ */ diff --git a/arch/arm/plat-omap/include/bridge/ntfy.h b/arch/arm/plat-omap/include/bridge/ntfy.h new file mode 100644 index 0000000..3e99a85 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/ntfy.h @@ -0,0 +1,146 @@ +/* + * bridge/inc/ntfy.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== ntfy.h ======== + * Purpose: + * Manage lists of notification events. + * + * Public Functions: + * NTFY_Create + * NTFY_Delete + * NTFY_Exit + * NTFY_Init + * NTFY_Notify + * NTFY_Register + * + *! Revision History: + *! ================= + *! 05-Nov-2001 kc: Updated NTFY_Register. + *! 07-Sep-2000 jeh Created. + */ + +#ifndef NTFY_ +#define NTFY_ + + struct NTFY_OBJECT; + +/* + * ======== NTFY_Create ======== + * Purpose: + * Create an empty list of notifications. + * Parameters: + * phNtfy: Location to store handle on output. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Memory allocation failure. + * Requires: + * NTFY_Init() called. + * phNtfy != NULL. + * Ensures: + * DSP_SUCCEEDED(status) <==> IsValid(*phNtfy). + */ + extern DSP_STATUS NTFY_Create(OUT struct NTFY_OBJECT **phNtfy); + +/* + * ======== NTFY_Delete ======== + * Purpose: + * Free resources allocated in NTFY_Create. + * Parameters: + * hNtfy: Handle returned from NTFY_Create(). + * Returns: + * Requires: + * NTFY_Init() called. + * IsValid(hNtfy). + * Ensures: + */ + extern void NTFY_Delete(IN struct NTFY_OBJECT *hNtfy); + +/* + * ======== NTFY_Exit ======== + * Purpose: + * Discontinue usage of NTFY module. + * Parameters: + * Returns: + * Requires: + * NTFY_Init() successfully called before. + * Ensures: + */ + extern void NTFY_Exit(); + +/* + * ======== NTFY_Init ======== + * Purpose: + * Initialize the NTFY module. + * Parameters: + * Returns: + * TRUE if initialization succeeded, FALSE otherwise. + * Ensures: + */ + extern bool NTFY_Init(); + +/* + * ======== NTFY_Notify ======== + * Purpose: + * Execute notify function (signal event or post message) for every + * element in the notification list that is to be notified about the + * event specified in uEventMask. + * Parameters: + * hNtfy: Handle returned from NTFY_Create(). + * uEventMask: The type of event that has occurred. + * Returns: + * Requires: + * NTFY_Init() called. + * IsValid(hNtfy). + * Ensures: + */ + extern void NTFY_Notify(IN struct NTFY_OBJECT *hNtfy, + IN u32 uEventMask); + +/* + * ======== NTFY_Register ======== + * Purpose: + * Add a notification element to the list. If the notification is already + * registered, and uEventMask != 0, the notification will get posted for + * events specified in the new event mask. If the notification is already + * registered and uEventMask == 0, the notification will be unregistered. + * Parameters: + * hNtfy: Handle returned from NTFY_Create(). + * hNotification: Handle to a DSP_NOTIFICATION object. + * uEventMask: Events to be notified about. + * uNotifyType: Type of notification: DSP_SIGNALEVENT. + * Returns: + * DSP_SOK: Success. + * DSP_EMEMORY: Insufficient memory. + * DSP_EVALUE: uEventMask is 0 and hNotification was not + * previously registered. + * DSP_EHANDLE: NULL hNotification, hNotification event name + * too long, or hNotification event name NULL. + * Requires: + * NTFY_Init() called. + * IsValid(hNtfy). + * hNotification != NULL. + * uNotifyType is DSP_SIGNALEVENT + * Ensures: + */ + extern DSP_STATUS NTFY_Register(IN struct NTFY_OBJECT *hNtfy, + IN struct DSP_NOTIFICATION + *hNotification, + IN u32 uEventMask, + IN u32 uNotifyType); + +#endif /* NTFY_ */ diff --git a/arch/arm/plat-omap/include/bridge/prcs.h b/arch/arm/plat-omap/include/bridge/prcs.h new file mode 100644 index 0000000..b660600 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/prcs.h @@ -0,0 +1,101 @@ +/* + * bridge/inc/prcs.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== prcs.h ======== + * Purpose: + * Return process and thread information. + * + * Public Functions: + * PRCS_Exit + * PRCS_GetCurrentHandle + * PRCS_GetCurThreadHandle + * PRCS_Init + * + *! Revision History: + *! ================ + *! 18-Dec-2000 rr: PRCS_GetCurrentProcesshandle's DBC_Ensure class + *! removed. See the foot node. + *! 06-Jul-2000 rr: Name changed to PRCS to accomodate RM PROC. + *! 29-Oct-1999 kc: Cleaned up for code review. + *! 22-Oct-1996 gp: Created. + */ + +#ifndef _PRCS_H +#define _PRCS_H + +/* + * ======== PRCS_Exit ======== + * Purpose: + * Discontinue usage of module; free resources when reference count + * reaches 0. + * Parameters: + * Returns: + * Requires: + * PRCS initialized. + * Ensures: + * Resources used by module are freed when cRef reaches zero. + */ + extern void PRCS_Exit(); + +/* + * ======== PRCS_GetCurrentHandle ======== + * Purpose: + * Retrieve the handle of the calling process. + * Parameters: + * phProcess: Location to store the current process handle. + * Returns: + * DSP_SOK: Success. + * DSP_EPOINTER: Invalid argument. + * Requires: + * - PRCS initialized. + * - phProcess != NULL. + * Ensures: + * + */ + extern DSP_STATUS PRCS_GetCurrentHandle(OUT HANDLE *phProcess); + +/* + * ======== PRCS_GetCurThreadHandle ======== + * Purpose: + * Retrieve the current thread handle + * Parameters: + * phThread: Location to store the current thread handle. + * Returns: + * DSP_SOK: Success. + * DSP_EPOINTER: Invalid argument. + * Requires: + * PRCS initialized. + * Ensures: + * If returned DSP_SOK, phThread is a valid pseudo thread handle. + */ + extern DSP_STATUS PRCS_GetCurThreadHandle(OUT HANDLE *phThread); + +/* + * ======== PRCS_Init ======== + * Purpose: + * Initializes private state of PROC module. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * PRCS initialized. + */ + extern bool PRCS_Init(); + +#endif /* _PRCS_H */ diff --git a/arch/arm/plat-omap/include/bridge/proc.h b/arch/arm/plat-omap/include/bridge/proc.h new file mode 100644 index 0000000..2b43085 --- /dev/null +++ b/arch/arm/plat-omap/include/bridge/proc.h @@ -0,0 +1,648 @@ +/* + * bridge/inc/proc.h + * + * DSP-BIOS Bridge driver support functions for TI OMAP processors. + * + * Copyright (C) 2005-2006 Texas Instruments, Inc. + * + * This package is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 2 as + * published by the Free Software Foundation. + * + * THIS PACKAGE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR + * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED + * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE. + */ + + +/* + * ======== proc.h ======== + * Description: + * This is the Class driver RM module interface. + * + * Public Functions: + * PROC_Attach + * PROC_Create + * PROC_Ctrl (OEM-function) + * PROC_Destroy + * PROC_Detach + * PROC_EnumNodes + * PROC_Exit + * PROC_FlushMemory + * PROC_GetDevObject (OEM-function) + * PROC_GetResourceInfo + * PROC_GetState + * PROC_GetProcessorId + * PROC_GetTrace (OEM-function) + * PROC_Init + * PROC_Load (OEM-function) + * PROC_Map + * PROC_NotifyAllclients + * PROC_NotifyClients (OEM-function) + * PROC_RegisterNotify + * PROC_ReserveMemory + * PROC_Start (OEM-function) + * PROC_UnMap + * PROC_UnReserveMemory + * + * Notes: + * + *! Revision History: + *! ================ + *! 19-Apr-2004 sb Aligned DMM definitions with Symbian + *! 08-Mar-2004 sb Added the Dynamic Memory Mapping APIs + *! 09-Feb-2003 vp: Added PROC_GetProcessorID function + *! 29-Nov-2000 rr: Incorporated code review changes. + *! 28-Sep-2000 rr: Updated to Version 0.9. + *! 10-Aug-2000 rr: PROC_NotifyClients, PROC_GetProcessorHandle Added + *! 27-Jul-2000 rr: Updated to ver 0.8 of DSPAPI(types). GetTrace added. + *! 27-Jun-2000 rr: Created from dspapi.h + */ + +#ifndef PROC_ +#define PROC_ + +#include +#include + +/* + * ======== PROC_Attach ======== + * Purpose: + * Prepare for communication with a particular DSP processor, and return + * a handle to the processor object. The PROC Object gets created + * Parameters: + * uProcessor : The processor index (zero-based). + * hMgrObject : Handle to the Manager Object + * pAttrIn : Ptr to the DSP_PROCESSORATTRIN structure. + * A NULL value means use default values. + * phProcessor : Ptr to location to store processor handle. + * Returns: + * DSP_SOK : Success. + * DSP_EFAIL : General failure. + * DSP_EHANDLE : Invalid processor handle. + * DSP_SALREADYATTACHED: Success; Processor already attached. + * Requires: + * phProcessor != NULL. + * PROC Initialized. + * Ensures: + * DSP_EFAIL, and *phProcessor == NULL, OR + * Success and *phProcessor is a Valid Processor handle OR + * DSP_SALREADYATTACHED and *phProcessor is a Valid Processor. + * Details: + * When pAttrIn is NULL, the default timeout value is 10 seconds. + */ + extern DSP_STATUS PROC_Attach(u32 uProcessor, + OPTIONAL CONST struct DSP_PROCESSORATTRIN + *pAttrIn, + OUT DSP_HPROCESSOR *phProcessor); + +/* + * ======== PROC_AutoStart ========= + * Purpose: + * A Particular device gets loaded with the default image + * if the AutoStart flag is set. + * Parameters: + * hDevObject : Handle to the Device + * Returns: + * DSP_SOK : On Successful Loading + * DSP_EFILE : No DSP exec file found. + * DSP_EFAIL : General Failure + * Requires: + * hDevObject != NULL. + * hDevNode != NULL. + * PROC Initialized. + * Ensures: + */ + extern DSP_STATUS PROC_AutoStart(struct CFG_DEVNODE *hDevNode, + struct DEV_OBJECT *hDevObject); + +/* + * ======== PROC_Ctrl ======== + * Purpose: + * Pass control information to the GPP device driver managing the DSP + * processor. This will be an OEM-only function, and not part of the + * 'Bridge application developer's API. + * Parameters: + * hProcessor : The processor handle. + * dwCmd : Private driver IOCTL cmd ID. + * pArgs : Ptr to an driver defined argument structure. + * Returns: + * DSP_SOK : SUCCESS + * DSP_EHANDLE : Invalid processor handle. + * DSP_ETIMEOUT: A Timeout Occured before the Control information + * could be sent. + * DSP_EACCESSDENIED: Client does not have the access rights required + * to call this function. + * DSP_ERESTART: A Critical error has occured and the DSP is being + * restarted. + * DSP_EFAIL : General Failure. + * Requires: + * PROC Initialized. + * Ensures + * Details: + * This function Calls WMD_BRD_Ioctl. + */ + extern DSP_STATUS PROC_Ctrl(DSP_HPROCESSOR hProcessor, + u32 dwCmd, IN struct DSP_CBDATA *pArgs); + +/* + * ======== PROC_Detach ======== + * Purpose: + * Close a DSP processor and de-allocate all (GPP) resources reserved + * for it. The Processor Object is deleted. + * Parameters: + * hProcessor : The processor handle. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : InValid Handle. + * DSP_EFAIL : General failure. + * Requires: + * PROC Initialized. + * Ensures: + * PROC Object is destroyed. + */ + extern DSP_STATUS PROC_Detach(DSP_HPROCESSOR hProcessor); + +/* + * ======== PROC_EnumNodes ======== + * Purpose: + * Enumerate the nodes currently allocated on a processor. + * Parameters: + * hProcessor : The processor handle. + * aNodeTab : The first Location of an array allocated for node + * handles. + * uNodeTabSize: The number of (DSP_HNODE) handles that can be held + * to the memory the client has allocated for aNodeTab + * puNumNodes : Location where DSPProcessor_EnumNodes will return + * the number of valid handles written to aNodeTab + * puAllocated : Location where DSPProcessor_EnumNodes will return + * the number of nodes that are allocated on the DSP. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_ESIZE : The amount of memory allocated for aNodeTab is + * insufficent. That is the number of nodes actually + * allocated on the DSP is greater than the value + * specified for uNodeTabSize. + * DSP_EFAIL : Unable to get Resource Information. + * Details: + * Requires + * puNumNodes is not NULL. + * puAllocated is not NULL. + * aNodeTab is not NULL. + * PROC Initialized. + * Ensures: + * Details: + */ + extern DSP_STATUS PROC_EnumNodes(DSP_HPROCESSOR hProcessor, + IN DSP_HNODE *aNodeTab, + IN u32 uNodeTabSize, + OUT u32 *puNumNodes, + OUT u32 *puAllocated); + +/* + * ======== PROC_GetResourceInfo ======== + * Purpose: + * Enumerate the resources currently available on a processor. + * Parameters: + * hProcessor : The processor handle. + * uResourceType: Type of resource . + * pResourceInfo: Ptr to the DSP_RESOURCEINFO structure. + * uResourceInfoSize: Size of the structure. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EWRONGSTATE: The processor is not in the PROC_RUNNING state. + * DSP_ETIMEOUT: A timeout occured before the DSP responded to the + * querry. + * DSP_ERESTART: A Critical error has occured and the DSP is being + * restarted. + * DSP_EFAIL : Unable to get Resource Information + * Requires: + * pResourceInfo is not NULL. + * Parameter uResourceType is Valid.[TBD] + * uResourceInfoSize is >= sizeof DSP_RESOURCEINFO struct. + * PROC Initialized. + * Ensures: + * Details: + * This function currently returns + * DSP_ENOTIMPL, and does not write any data to the pResourceInfo struct. + */ + extern DSP_STATUS PROC_GetResourceInfo(DSP_HPROCESSOR hProcessor, + u32 uResourceType, + OUT struct DSP_RESOURCEINFO * + pResourceInfo, + u32 uResourceInfoSize); + +/* + * ======== PROC_Exit ======== + * Purpose: + * Decrement reference count, and free resources when reference count is + * 0. + * Parameters: + * Returns: + * Requires: + * PROC is initialized. + * Ensures: + * When reference count == 0, PROC's private resources are freed. + */ + extern void CDECL PROC_Exit(); + +/* + * ======== PROC_GetDevObject ========= + * Purpose: + * Returns the DEV Hanlde for a given Processor handle + * Parameters: + * hProcessor : Processor Handle + * phDevObject : Location to store the DEV Handle. + * Returns: + * DSP_SOK : Success; *phDevObject has Dev handle + * DSP_EFAIL : Failure; *phDevObject is zero. + * Requires: + * phDevObject is not NULL + * PROC Initialized. + * Ensures: + * DSP_SOK : *phDevObject is not NULL + * DSP_EFAIL : *phDevObject is NULL. + */ + extern DSP_STATUS PROC_GetDevObject(DSP_HPROCESSOR hProcessor, + struct DEV_OBJECT **phDevObject); + +/* + * ======== PROC_Init ======== + * Purpose: + * Initialize PROC's private state, keeping a reference count on each + * call. + * Parameters: + * Returns: + * TRUE if initialized; FALSE if error occured. + * Requires: + * Ensures: + * TRUE: A requirement for the other public PROC functions. + */ + extern bool CDECL PROC_Init(); + +/* + * ======== PROC_GetState ======== + * Purpose: + * Report the state of the specified DSP processor. + * Parameters: + * hProcessor : The processor handle. + * pProcStatus : Ptr to location to store the DSP_PROCESSORSTATE + * structure. + * uStateInfoSize: Size of DSP_PROCESSORSTATE. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EFAIL : General failure while querying processor state. + * Requires: + * pProcStatus is not NULL + * uStateInfoSize is >= than the size of DSP_PROCESSORSTATE structure. + * PROC Initialized. + * Ensures: + * Details: + */ + extern DSP_STATUS PROC_GetState(DSP_HPROCESSOR hProcessor, + OUT struct DSP_PROCESSORSTATE + *pProcStatus, + u32 uStateInfoSize); + +/* + * ======== PROC_GetProcessorID ======== + * Purpose: + * Report the state of the specified DSP processor. + * Parameters: + * hProcessor : The processor handle. + * procID : Processor ID + * + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EFAIL : General failure while querying processor state. + * Requires: + * pProcStatus is not NULL + * uStateInfoSize is >= than the size of DSP_PROCESSORSTATE structure. + * PROC Initialized. + * Ensures: + * Details: + */ + extern DSP_STATUS PROC_GetProcessorId(DSP_HPROCESSOR hProcessor, + u32 *procID); + +/* + * ======== PROC_GetTrace ======== + * Purpose: + * Retrieve the trace buffer from the specified DSP processor. + * Parameters: + * hProcessor : The processor handle. + * pBuf : Ptr to buffer to hold trace output. + * uMaxSize : Maximum size of the output buffer. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EFAIL : General failure while retireving processor trace + * Buffer. + * Requires: + * pBuf is not NULL + * uMaxSize is > 0. + * PROC Initialized. + * Ensures: + * Details: + */ + extern DSP_STATUS PROC_GetTrace(DSP_HPROCESSOR hProcessor, u8 *pBuf, + u32 uMaxSize); + +/* + * ======== PROC_Load ======== + * Purpose: + * Reset a processor and load a new base program image. + * This will be an OEM-only function. + * Parameters: + * hProcessor : The processor handle. + * iArgc : The number of Arguments(strings)in the aArgV[] + * aArgv : An Array of Arguments(Unicode Strings) + * aEnvp : An Array of Environment settings(Unicode Strings) + * Returns: + * DSP_SOK : Success. + * DSP_EFILE : The DSP Execuetable was not found. + * DSP_EHANDLE : Invalid processor handle. + * DSP_ECORRUTFILE: Unable to Parse the DSP Execuetable + * DSP_EATTACHED: Abort because a GPP Client is attached to the + * specified Processor + * DSP_EACCESSDENIED: Client does not have the required access rights + * to reset and load the Processor + * DSP_EFAIL : Unable to Load the Processor + * Requires: + * aArgv is not NULL + * iArgc is > 0 + * PROC Initialized. + * Ensures: + * Success and ProcState == PROC_LOADED + * or DSP_FAILED status. + * Details: + * Does not implement access rights to control which GPP application + * can load the processor. + */ + extern DSP_STATUS PROC_Load(DSP_HPROCESSOR hProcessor, + IN CONST s32 iArgc, IN CONST char **aArgv, + IN CONST char **aEnvp); + +/* + * ======== PROC_RegisterNotify ======== + * Purpose: + * Register to be notified of specific processor events + * Parameters: + * hProcessor : The processor handle. + * uEventMask : Mask of types of events to be notified about. + * uNotifyType : Type of notification to be sent. + * hNotification: Handle to be used for notification. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle or hNotification. + * DSP_EVALUE : Parameter uEventMask is Invalid + * DSP_ENOTIMP : The notification type specified in uNotifyMask + * is not supported. + * DSP_EFAIL : Unable to register for notification. + * Requires: + * hNotification is not NULL + * PROC Initialized. + * Ensures: + * Details: + */ + extern DSP_STATUS PROC_RegisterNotify(DSP_HPROCESSOR hProcessor, + u32 uEventMask, u32 uNotifyType, + struct DSP_NOTIFICATION + *hNotification); + +/* + * ======== PROC_NotifyClients ======== + * Purpose: + * Notify the Processor Clients + * Parameters: + * hProc : The processor handle. + * uEvents : Event to be notified about. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EFAIL : Failure to Set or Reset the Event + * Requires: + * uEvents is Supported or Valid type of Event + * hProc is a valid handle + * PROC Initialized. + * Ensures: + */ + extern DSP_STATUS PROC_NotifyClients(DSP_HPROCESSOR hProc, + u32 uEvents); + +/* + * ======== PROC_NotifyAllClients ======== + * Purpose: + * Notify the Processor Clients + * Parameters: + * hProc : The processor handle. + * uEvents : Event to be notified about. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EFAIL : Failure to Set or Reset the Event + * Requires: + * uEvents is Supported or Valid type of Event + * hProc is a valid handle + * PROC Initialized. + * Ensures: + * Details: + * NODE And STRM would use this function to notify their clients + * about the state changes in NODE or STRM. + */ + extern DSP_STATUS PROC_NotifyAllClients(DSP_HPROCESSOR hProc, + u32 uEvents); + +/* + * ======== PROC_Start ======== + * Purpose: + * Start a processor running. + * Processor must be in PROC_LOADED state. + * This will be an OEM-only function, and not part of the 'Bridge + * application developer's API. + * Parameters: + * hProcessor : The processor handle. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EWRONGSTATE: Processor is not in PROC_LOADED state. + * DSP_EFAIL : Unable to start the processor. + * Requires: + * PROC Initialized. + * Ensures: + * Success and ProcState == PROC_RUNNING or DSP_FAILED status. + * Details: + */ + extern DSP_STATUS PROC_Start(DSP_HPROCESSOR hProcessor); + +/* + * ======== PROC_Stop ======== + * Purpose: + * Start a processor running. + * Processor must be in PROC_LOADED state. + * This will be an OEM-only function, and not part of the 'Bridge + * application developer's API. + * Parameters: + * hProcessor : The processor handle. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDLE : Invalid processor handle. + * DSP_EWRONGSTATE: Processor is not in PROC_LOADED state. + * DSP_EFAIL : Unable to start the processor. + * Requires: + * PROC Initialized. + * Ensures: + * Success and ProcState == PROC_RUNNING or DSP_FAILED status. + * Details: + */ + extern DSP_STATUS PROC_Stop(DSP_HPROCESSOR hProcessor); + +/* + * ======== PROC_FlushMemory ======== + * Purpose: + * Flushes a buffer from the MPU data cache. + * Parameters: + * hProcessor : The processor handle. + * pMpuAddr : Buffer start address + * ulSize : Buffer size + * ulFlags : Reserved. + * Returns: + * DSP_SOK : Success. + * DSP_EHANDL