ires_common.h

Go to the documentation of this file.

/*
 * Copyright (c) 2006-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 IRES_COMMON_
#define IRES_COMMON_



#ifdef __cplusplus
extern "C" {
#endif

#include "ialg.h"


typedef enum IRES_Status {
    IRES_OK = 0,                
    IRES_EALG = 1,              
    IRES_EEXISTS = 2,           
    IRES_EFAIL = 3,             
    IRES_EINIT = 4,             
    IRES_ENOINIT = 5,           
    IRES_ENOMEM = 6,            
    IRES_ENORESOURCE = 7,       
    IRES_ENOTFOUND = 8          
} IRES_Status;

typedef struct IRES_ProtocolRevision {
    unsigned int Major;
    unsigned int Source;
    unsigned int Radius;                /* Using unsigned int here to support
                                         * xdc/std.h as well as tistdtypes.h
                                         */
} IRES_ProtocolRevision;


typedef enum IRES_RequestMode {
    IRES_SCRATCH,               
    IRES_PERSISTENT,            
    IRES_LATEACQUIRE            
} IRES_RequestMode;


typedef struct IRES_ProtocolArgs {

    Int32 size;                 
    IRES_RequestMode mode;      
} IRES_ProtocolArgs;

typedef struct IRES_ResourceDescriptor {

    String resourceName;

    struct IRES_ProtocolArgs  *protocolArgs;

    IRES_ProtocolRevision *revision;

    struct IRES_Obj * handle;

} IRES_ResourceDescriptor;

typedef struct IRES_Properties {
    Int32 size;                 
} IRES_Properties;

typedef struct IRES_Obj {

    Int32 persistent;

    Void (*getStaticProperties) (struct IRES_Obj * resourceHandle,
        IRES_Properties * resourceProperties);

} IRES_Obj;

typedef struct IRES_Obj *IRES_Handle;



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

#endif  /* IRES_COMMON_ */