ires_tiledmemory.h

Go to the documentation of this file.

/*
 * Copyright (c) 2012, 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_sdo_fc_ires_tiledmemory_IRES_TILEDMEMORY_
#define ti_sdo_fc_ires_tiledmemory_IRES_TILEDMEMORY_



#ifdef __cplusplus
extern "C" {
#endif

#include <ti/xdais/xdas.h>
#include <ti/xdais/ires_common.h>
#include <ti/xdais/ires.h>

#define IRES_TILEDMEMORY_PROTOCOLNAME       "ti.sdo.fc.ires.tiledmemory"

#define TILEDMEMORY_MODNAME  "ti.sdo.fc.ires.tiledmemory"

/*
 * Note, we wrap the PROTOCOLVERSION in an ifdef so the
 * resource managers and algs get this version data placed in their object
 * files.  Apps, which include rman.h, will have this 'NOPROTOCOLREV' defined.
 */
#ifndef ti_sdo_fc_ires_NOPROTOCOLREV

static IRES_ProtocolRevision IRES_TILEDMEMORY_PROTOCOLREVISION = {1, 0, 0};

#endif

typedef struct IRES_TILEDMEMORY_Obj *IRES_TILEDMEMORY_Handle;

typedef enum IRES_TILEDMEMORY_AccessDimension {
    IRES_TILEDMEMORY_1D = 0,
    IRES_TILEDMEMORY_2D = 1
} IRES_TILEDMEMORY_AccessDimension;


typedef enum IRES_TILEDMEMORY_AccessUnit {

    IRES_TILEDMEMORY_RAW = 0,                   
    IRES_TILEDMEMORY_PAGE = 1,                  
    IRES_TILEDMEMORY_8BIT = 2,                  
    IRES_TILEDMEMORY_16BIT = 3,                 
    IRES_TILEDMEMORY_32BIT = 4                  
} IRES_TILEDMEMORY_AccessUnit;

typedef struct IRES_TILEDMEMORY_ProtocolArgs {

    IRES_ProtocolArgs base;

    XDAS_UInt32 accessDimension;        
    XDAS_UInt32 accessUnit;             
    int sizeDim0;

    int sizeDim1;

    int alignment;

} IRES_TILEDMEMORY_ProtocolArgs;

typedef struct IRES_TILEDMEMORY_Obj {

    IRES_Obj ires;
    XDAS_Void * info ;                  
    XDAS_Void * memoryBaseAddress;      
    XDAS_UInt32 isTiledMemory;          
    XDAS_UInt32 accessUnit;             
    XDAS_Void * tilerBaseAddress;       
    XDAS_Void * systemSpaceBaseAddress; 
} IRES_TILEDMEMORY_Obj;

typedef struct IRES_TILEDMEMORY_RegisterLayer {

    int size;
    /* TBD */
} IRES_TILEDMEMORY_RegisterLayer;

typedef struct IRES_TILEDMEMORY_Properties {

    int size;
} IRES_TILEDMEMORY_Properties;

#ifdef __cplusplus
}
#endif /* extern "C" */

#endif