iresman_protocol.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 IRESMAN_PROTOCOL
#define IRESMAN_PROTOCOL



#ifdef __cplusplus
extern "C" {
#endif

#include <ti/xdais/ires_common.h>

typedef struct IRESMAN_ConstructArgs {

    Int32 size;   /* size of this structure */

} IRESMAN_ConstructArgs;


typedef struct IRESMAN_ConstructFxns {

    String (*getName)();

    IRES_ProtocolRevision * (* getRevision)();

    IRES_Status (*getMemRecs)(IRES_Handle handle,
            IRES_ProtocolArgs *protocolArgs, IALG_MemRec *memRecs);

    Int (*getNumMemRecs)(IRES_ProtocolArgs *protocolArgs);


    IRES_Handle (*constructHandle)(IRES_ProtocolArgs *protocolArgs,
            IALG_MemRec *memRecs,
            IRESMAN_ConstructArgs * constructHandleArgs,
            IRES_Status *status);

    IRES_Status (*destructHandle)(IRES_Handle handle);

} IRESMAN_ConstructFxns;


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

#endif  /* IRESMAN_PROTOCOL */