ProcMgr.h

Go to the documentation of this file.

/* 
 *  ============================================================================
 *
 *  Copyright (c) 2008-2012, Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *  
 *  *  Redistributions of source code must retain the above copyright
 *     notice, this list of conditions and the following disclaimer.
 *  
 *  *  Redistributions in binary form must reproduce the above copyright
 *     notice, this list of conditions and the following disclaimer in the
 *     documentation and/or other materials provided with the distribution.
 *  
 *  *  Neither the name of Texas Instruments Incorporated nor the names of
 *     its contributors may be used to endorse or promote products derived
 *     from this software without specific prior written permission.
 *  
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 *  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 *  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 *  CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 *  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 *  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 *  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 *  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 *  OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 *  EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *  Contact information for paper mail:
 *  Texas Instruments
 *  Post Office Box 655303
 *  Dallas, Texas 75265
 *  Contact information: 
 *  http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm?
 *  DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact
 *  ============================================================================
 *  
 */


#ifndef ProcMgr_H_0xf2ba
#define ProcMgr_H_0xf2ba

#if defined (__cplusplus)
extern "C" {
#endif


/* =============================================================================
 *  All success and failure codes for the module
 * =============================================================================
 */
#define ProcMgr_S_SETUP            5

#define ProcMgr_S_OPENHANDLE       4

#define ProcMgr_S_ALREADYEXISTS    3

#define ProcMgr_S_BUSY             2

#define ProcMgr_S_ALREADYSETUP     1

#define ProcMgr_S_SUCCESS          0

#define ProcMgr_E_FAIL             -1

#define ProcMgr_E_INVALIDARG       -2

#define ProcMgr_E_MEMORY           -3

#define ProcMgr_E_ALREADYEXISTS    -4

#define ProcMgr_E_NOTFOUND         -5

#define ProcMgr_E_TIMEOUT          -6

#define ProcMgr_E_INVALIDSTATE     -7

#define ProcMgr_E_OSFAILURE        -8

#define ProcMgr_E_RESOURCE         -9

#define ProcMgr_E_RESTART          -10

#define ProcMgr_E_HANDLE           -11

#define ProcMgr_E_ACCESSDENIED     -12

#define ProcMgr_E_TRANSLATE        -13

#define ProcMgr_E_SYMBOLNOTFOUND   -14

#define ProcMgr_E_MAP              -15


/* =============================================================================
 *  Macros and types
 * =============================================================================
 */
#define IS_VALID_PROCID(id)   (id < MultiProc_MAXPROCESSORS)

typedef struct ProcMgr_Object * ProcMgr_Handle;


typedef enum {
    ProcMgr_State_Unknown     = 0u,
    ProcMgr_State_Powered     = 1u,
    ProcMgr_State_Reset       = 2u,
    ProcMgr_State_Loaded      = 3u,
    ProcMgr_State_Running     = 4u,
    ProcMgr_State_Unavailable = 5u,
    ProcMgr_State_EndValue    = 6u
} ProcMgr_State ;

typedef enum {
    ProcMgr_BootMode_Boot           = 0u,
    ProcMgr_BootMode_NoLoad_Pwr     = 1u,
    ProcMgr_BootMode_NoLoad_NoPwr   = 2u,
    ProcMgr_BootMode_NoBoot         = 3u,
    ProcMgr_BootMode_EndValue       = 4u
} ProcMgr_BootMode ;

typedef enum {
    ProcMgr_AddrType_MasterKnlVirt = 0u,
    ProcMgr_AddrType_MasterUsrVirt = 1u,
    ProcMgr_AddrType_MasterPhys    = 2u,
    ProcMgr_AddrType_SlaveVirt     = 3u,
    ProcMgr_AddrType_SlavePhys     = 4u,
    ProcMgr_AddrType_EndValue      = 5u
} ProcMgr_AddrType;

typedef UInt32 ProcMgr_MapMask;

#define ProcMgr_MASTERKNLVIRT   (ProcMgr_MapMask)(1 << 0)

#define ProcMgr_MASTERUSRVIRT   (ProcMgr_MapMask)(1 << 1)

#define ProcMgr_SLAVEVIRT       (ProcMgr_MapMask)(1 << 2)

typedef struct ProcMgr_AttachParams_tag {
    ProcMgr_BootMode bootMode;
    Ptr              bootParams;
} ProcMgr_AttachParams ;

typedef struct ProcMgr_StartParams_tag {
    UInt32 reserved;
} ProcMgr_StartParams ;


typedef struct ProcMgr_AddrInfo_tag {
    UInt32          addr [ProcMgr_AddrType_EndValue];
    UInt32          size;
    Bool            isCached;
    Bool            isMapped;
    ProcMgr_MapMask mapMask;
    UInt16          refCount;
} ProcMgr_AddrInfo;

typedef struct ProcMgr_MappedMemEntry {
    ProcMgr_AddrInfo info;
    ProcMgr_AddrType srcAddrType;
    ProcMgr_MapMask  mapMask;
    Bool             inUse;
} ProcMgr_MappedMemEntry;

typedef struct ProcMgr_ProcInfo_tag {
    ProcMgr_BootMode       bootMode;
    UInt16                 maxMemoryRegions;
    UInt16                 numMemEntries;
    ProcMgr_MappedMemEntry memEntries [0];
} ProcMgr_ProcInfo;


typedef struct ProcMgr_SectionInfo_tag {
   UInt32    physicalAddress;
   UInt32    virtualAddress;
   UInt16    sectId;
   UInt32    size;
} ProcMgr_SectionInfo;


/* =============================================================================
 *  APIs
 * =============================================================================
 */
Int ProcMgr_open (ProcMgr_Handle * handlePtr, UInt16 procId);

Int ProcMgr_close (ProcMgr_Handle * handlePtr);

Void ProcMgr_getAttachParams (ProcMgr_Handle         handle,
                              ProcMgr_AttachParams * params);

Int ProcMgr_attach (ProcMgr_Handle handle, ProcMgr_AttachParams * params);

Int ProcMgr_detach (ProcMgr_Handle handle);

Int ProcMgr_load (ProcMgr_Handle handle,
                  String         imagePath,
                  UInt32         argc,
                  String *       argv,
                  Ptr            params,
                  UInt32 *       fileId);

Int ProcMgr_unload (ProcMgr_Handle handle, UInt32 fileId);

Void ProcMgr_getStartParams (ProcMgr_Handle        handle,
                             ProcMgr_StartParams * params);

Int ProcMgr_start (ProcMgr_Handle handle, ProcMgr_StartParams * params);

Int ProcMgr_stop (ProcMgr_Handle handle);

ProcMgr_State ProcMgr_getState (ProcMgr_Handle handle);

Int ProcMgr_read (ProcMgr_Handle handle,
                  UInt32         procAddr,
                  UInt32 *       numBytes,
                  Ptr            buffer);

Int ProcMgr_write (ProcMgr_Handle handle,
                   UInt32         procAddr,
                   UInt32 *       numBytes,
                   Ptr            buffer);

Int ProcMgr_control (ProcMgr_Handle handle, Int32 cmd, Ptr arg);

Int ProcMgr_translateAddr (ProcMgr_Handle   handle,
                           Ptr *            dstAddr,
                           ProcMgr_AddrType dstAddrType,
                           Ptr              srcAddr,
                           ProcMgr_AddrType srcAddrType);

Int ProcMgr_getSymbolAddress (ProcMgr_Handle handle,
                              UInt32         fileId,
                              String         symbolName,
                              UInt32 *       symValue);

Int ProcMgr_map (ProcMgr_Handle     handle,
                 ProcMgr_MapMask    mapMask,
                 ProcMgr_AddrInfo * addrInfo,
                 ProcMgr_AddrType   srcAddrType);

Int ProcMgr_unmap (ProcMgr_Handle     handle,
                   ProcMgr_MapMask    mapMask,
                   ProcMgr_AddrInfo * addrInfo,
                   ProcMgr_AddrType   srcAddrType);

UInt32 ProcMgr_getMaxMemoryRegions(ProcMgr_Handle handle);


Int ProcMgr_getProcInfo (ProcMgr_Handle     handle,
                         ProcMgr_ProcInfo * procInfo);


Int ProcMgr_getSectionInfo (ProcMgr_Handle        handle,
                            UInt32                fileId,
                            String                sectionName,
                            ProcMgr_SectionInfo * sectionInfo);

Int ProcMgr_getSectionData (ProcMgr_Handle        handle,
                            UInt32                fileId,
                            ProcMgr_SectionInfo * sectionInfo,
                            Ptr                   buffer);


UInt32 ProcMgr_getLoadedFileId (ProcMgr_Handle handle);


#if defined (__cplusplus)
}
#endif /* defined (__cplusplus) */

#endif /* ProcMgr_H_0xf2ba */