RingIO.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 RINGIO_H_0xd3f4
#define RINGIO_H_0xd3f4

/* Utilities headers */
#include <ti/syslink/SysLink.h>

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


/* =============================================================================
 *  All success and failure codes for the module
 * =============================================================================
 */
#define RingIO_S_PENDINGATTRIBUTE    4

#define RingIO_S_NOTCONTIGUOUSDATA   3

#define RingIO_S_BUSY                 2

#define RingIO_S_ALREADYSETUP         1

#define RingIO_S_SUCCESS              0

#define RingIO_E_FAIL                 -1

#define RingIO_E_INVALIDARG           -2

#define RingIO_E_MEMORY               -3

#define RingIO_E_ALREADYEXISTS        -4

#define RingIO_E_NOTFOUND             -5

#define RingIO_E_TIMEOUT              -6

#define RingIO_E_INVALIDSTATE         -7

#define RingIO_E_OSFAILURE            -8

#define RingIO_E_RESOURCE             -9

#define RingIO_E_RESTART              -10

#define RingIO_E_INVALIDMSG           -11

#define RingIO_E_NOTOWNER             -12

#define RingIO_E_REMOTEACTIVE         -13

#define RingIO_E_INVALIDHEAPID        -14

#define RingIO_E_INVALIDPROCID        -15

#define RingIO_E_MAXREACHED           -16

#define RingIO_E_INUSE                -17

#define RingIO_E_INVALIDCONTEXT       -18

#define RingIO_E_BADVERSION           -19

#define RingIO_E_BUFWRAP              -20

#define RingIO_E_BUFEMPTY             -21

#define RingIO_E_BUFFULL              -22

#define RingIO_E_PENDINGDATA          -23

#define RingIO_E_VARIABLEATTRIBUTE   -24


#define RingIO_E_WRONGSTATE          -25

#define RingIO_E_NOTIFYFAIL          -26

#define RingIO_E_PENDINGATTRIBUTE   -27


/* =============================================================================
 *  Typedefs
 * =============================================================================
 */
typedef Ptr                       RingIO_BufPtr;

typedef UInt16                    RingIO_NotifyMsg;

/* =============================================================================
 *  Forward declarations
 * =============================================================================
 */
typedef struct RingIO_Object   *  RingIO_Handle;

/* =============================================================================
 * Structures & Enums
 * =============================================================================
 */

typedef enum RingIO_Type_Tag {
    RingIO_Type_SHAREDMEM = 0x0
} RingIO_Type;

/* =============================================================================
 *  Structures for instance related configuration
 * =============================================================================
 */
typedef struct RingIO_Params_Tag {
    String        name;
    RingIO_Type interfaceType;
} RingIO_Params;

typedef enum RingIO_OpenMode_Tag {
    RingIO_MODE_READER = 0x0,
    RingIO_MODE_WRITER = 0x1
} RingIO_OpenMode;

typedef struct RingIO_openParams_Tag {
    UInt32      flags;
    RingIO_OpenMode openMode;
} RingIO_openParams;


typedef struct RingIO_sharedMemReqDetails_tag {
     UInt32        ctrlSharedMemReq;
     UInt32        dataSharedMemReq;
     UInt32        attrSharedMemReq;
} RingIO_sharedMemReqDetails;


typedef enum RingIO_Flags_tag  {
    RingIO_DATABUF_MAINTAINCACHE = 0x1,
    RingIO_NEED_EXACT_SIZE   = 0x2
} RingIO_Flags;

typedef enum RingIO_NotifyType_Tag {
    RingIO_NOTIFICATION_NONE   = SysLink_NOTIFICATION_NONE,
    RingIO_NOTIFICATION_ALWAYS = SysLink_NOTIFICATION_ALWAYS,
    RingIO_NOTIFICATION_ONCE   = SysLink_NOTIFICATION_ONCE,
    RingIO_NOTIFICATION_HDWRFIFO_ALWAYS =
                                  SysLink_NOTIFICATION_HDWRFIFO_ALWAYS,
    RingIO_NOTIFICATION_HDWRFIFO_ONCE   =
                                  SysLink_NOTIFICATION_HDWRFIFO_ONCE
} RingIO_NotifyType;

typedef void (* RingIO_NotifyFxn ) (RingIO_Handle, Ptr, RingIO_NotifyMsg);


/* =============================================================================
 * APIs to be used in Application
 * =============================================================================
 */
/* =============================================================================
 * Instance creation and deletion related API's
 * =============================================================================
 */
Void RingIO_Params_init (Void * params);

RingIO_Handle RingIO_create(const Void *params);

Int RingIO_delete(RingIO_Handle *handlePtr);

UInt32 RingIO_sharedMemReq(const Void *params,
        RingIO_sharedMemReqDetails *sharedMemReqDetails);

/* =============================================================================
 * Instance opening and closing related API's
 * =============================================================================
 */
Int RingIO_open(String name, const RingIO_openParams *params, UInt16 *procIds,
        RingIO_Handle *handlePtr);

Int RingIO_openByAddr(Ptr ctrlSharedAddr, const RingIO_openParams *params,
        RingIO_Handle *handlePtr);

Int RingIO_close(RingIO_Handle *handlePtr);


/* =============================================================================
 * Instance Notification related API's
 * =============================================================================
 */
Int RingIO_registerNotifier(RingIO_Handle handle,
        RingIO_NotifyType notifyType, UInt32 watermark,
        RingIO_NotifyFxn notifyFunc, Ptr cbContext);

Int RingIO_unregisterNotifier(RingIO_Handle handle);

Int RingIO_setWaterMark(RingIO_Handle handle, UInt32 watermark);


Int RingIO_setNotifyType(RingIO_Handle handle, RingIO_NotifyType notifyType);


/*=============================================================================
 * Main RingIO APIs called by application for RingIO functions
 *=============================================================================
 */
Int RingIO_acquire(RingIO_Handle handle, RingIO_BufPtr *pData, UInt32 *pSize);


Int RingIO_release(RingIO_Handle handle, UInt32 size);


Int RingIO_cancel(RingIO_Handle handle);


Int RingIO_getvAttribute(RingIO_Handle handle, UInt16 *type, UInt32 *param,
        RingIO_BufPtr vptr, UInt32 *pSize);


Int RingIO_setvAttribute(RingIO_Handle handle, UInt16 type, UInt32 param,
        RingIO_BufPtr pData, UInt32 size, Bool sendNotification);


Int RingIO_getAttribute(RingIO_Handle handle, UInt16 *type, UInt32 *param);

Int RingIO_setAttribute(RingIO_Handle handle, UInt16 type, UInt32 param,
        Bool sendNotification);


Int RingIO_flush(RingIO_Handle handle, Bool hardFlush, UInt16 *type,
        UInt32 *param, UInt32 *bytesFlushed);


Int RingIO_sendNotify(RingIO_Handle handle, RingIO_NotifyMsg msg);


/*=============================================================================
 * Helper APIs
 *=============================================================================
 */
UInt RingIO_getValidSize(RingIO_Handle handle);

UInt RingIO_getEmptySize(RingIO_Handle handle);

UInt RingIO_getValidAttrSize(RingIO_Handle handle);

UInt RingIO_getEmptyAttrSize(RingIO_Handle handle);

UInt RingIO_getAcquiredOffset(RingIO_Handle handle);

UInt RingIO_getAcquiredSize(RingIO_Handle handle);

UInt RingIO_getWaterMark(RingIO_Handle handle);

#if defined (__cplusplus)
}
#endif


#endif /* RINGIO_H_0xd3f4 */