ialg.h

Go to the documentation of this file.

/* 
 * Copyright (c) 2010, Texas Instruments Incorporated
 * All rights reserved.
 *
 * 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.
 * 
 */

#ifndef ti_xdais_IALG_
#define ti_xdais_IALG_

#ifdef __cplusplus
extern "C" {
#endif


/*---------------------------*/
/*    TYPES AND CONSTANTS    */
/*---------------------------*/

#define IALG_DEFMEMRECS 4   
#define IALG_OBJMEMREC  0   
#define IALG_SYSCMD     256 
#define IALG_EOK        0   
#define IALG_EFAIL      -1  
#define IALG_CUSTOMFAILBASE  -2048
#define IALG_CUSTOMFAILEND -256   
typedef enum IALG_MemAttrs {
    IALG_SCRATCH,           
    IALG_PERSIST,           
    IALG_WRITEONCE          
} IALG_MemAttrs;

#define IALG_MPROG  0x0008  
#define IALG_MXTRN  0x0010  
/*
 *  ======== IALG_MemSpace ========
 */
typedef enum IALG_MemSpace {
    IALG_EPROG =            
        IALG_MPROG | IALG_MXTRN,

    IALG_IPROG =            
        IALG_MPROG,

    IALG_ESDATA =           
        IALG_MXTRN + 0,

    IALG_EXTERNAL =         
        IALG_MXTRN + 1,

    IALG_DARAM0 = 0,        
    IALG_DARAM1 = 1,        
    IALG_SARAM  = 2,        
    IALG_SARAM0 = 2,        
    IALG_SARAM1 = 3,        
    IALG_DARAM2 = 4,        
    IALG_SARAM2 = 5         
} IALG_MemSpace;

/*
 *  ======== IALG_isProg ========
 */
#define IALG_isProg(s) (        \
    (((int)(s)) & IALG_MPROG)   \
)

/*
 *  ======== IALG_isOffChip ========
 */
#define IALG_isOffChip(s) (     \
    (((int)(s)) & IALG_MXTRN)   \
)


typedef struct IALG_MemRec {
    Uns             size;       
    Int             alignment;  
    IALG_MemSpace   space;      
    IALG_MemAttrs   attrs;      
    Void            *base;      
} IALG_MemRec;


typedef struct IALG_Obj {
    struct IALG_Fxns *fxns;     
} IALG_Obj;


typedef struct IALG_Obj *IALG_Handle;


typedef struct IALG_Params {
    Int size;       
} IALG_Params;


typedef struct IALG_Status {
    Int size;       
} IALG_Status;


typedef unsigned int IALG_Cmd;


/*
 *      algAlloc()        - apps call this to query the algorithm about
 *                          its memory requirements. Must be non-NULL.
 *      algControl()      - algorithm specific control operations.  May be
 *                          NULL; NULL => no operations supported.
 *      algDeactivate()   - notification that current instance is about to
 *                          be "deactivated".  May be NULL; NULL => do nothing.
 *      algFree()         - query algorithm for memory to free when removing
 *                          an instance.  Must be non-NULL.
 *      algInit()         - apps call this to allow the algorithm to
 *                          initialize memory requested via algAlloc().  Must
 *                          be non-NULL.
 *      algMoved()        - apps call this whenever an algorithms object or
 *                          any pointer parameters are moved in real-time.
 *                          May be NULL; NULL => object can not be moved.
 *      algNumAlloc()     - query algorithm for number of memory requests.
 *                          May be NULL; NULL => number of mem recs is less
 *                          then #IALG_DEFMEMRECS.
 */
typedef struct IALG_Fxns {
    Void    *implementationId;

    Void    (*algActivate)(IALG_Handle handle);

    Int     (*algAlloc)(const IALG_Params *params,
        struct IALG_Fxns **parentFxns, IALG_MemRec *memTab);

    Int     (*algControl)(IALG_Handle handle, IALG_Cmd cmd,
        IALG_Status *status);

    Void    (*algDeactivate)(IALG_Handle handle);

    Int     (*algFree)(IALG_Handle handle, IALG_MemRec *memTab);

    Int     (*algInit)(IALG_Handle handle, const IALG_MemRec *memTab,
        IALG_Handle parent, const IALG_Params *params);

    Void    (*algMoved)(IALG_Handle handle, const IALG_MemRec *memTab,
        IALG_Handle parent, const IALG_Params *params);

    Int     (*algNumAlloc)(Void);
} IALG_Fxns;

#ifdef __cplusplus
}
#endif

#endif  /* ti_xdais_IALG_ */
/*
 *  @(#) ti.xdais; 1, 2.0, 1,243; 5-4-2010 08:43:56; /db/wtree/library/trees/dais/dais-q11x/src/
 */