FrameQ.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 FRAMEQ_H_0x6e6f
#define FRAMEQ_H_0x6e6f

#include <ti/syslink/FrameQDefs.h>
#include <ti/syslink/SysLink.h>
#include <ti/ipc/Notify.h>

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

/* =============================================================================
 *  All success and failure codes for the module
 * =============================================================================
 */
#define FrameQ_S_ALREADYDESTROYED           2

#define FrameQ_S_ALREADYSETUP               1

#define FrameQ_S_SUCCESS                    0

#define FrameQ_E_FAIL                       -1

#define FrameQ_E_INVALIDARG                 -2

#define FrameQ_E_NOTFOUND                   -3

#define FrameQ_E_INST_EXISTS                -4

#define FrameQ_E_WRITER_EXISTS              -5

#define FrameQ_E_ALLOC_FRAME                -6

#define FrameQ_E_ALLOC_FRAMEBUF             -7

#define FrameQ_E_MEMORY                     -8

#define FrameQ_E_EMPTY                      -9

#define FrameQ_E_CREATE_NAMESERVER          -10

#define FrameQ_E_CREATE_GATEMP              -11

#define FrameQ_E_OPEN_GATEMP                -12

#define FrameQ_E_FAIL_CLIENTN0TIFYMGR_CREATE -13

#define FrameQ_E_FAIL_CLIENTN0TIFYMGR_OPEN  -14

#define FrameQ_E_MAX_READERS                -15

#define FrameQ_E_ACCESSDENIED               -16

#define FrameQ_E_INVALIDSTATE               -17

#define FrameQ_E_OSFAILURE                  -18

#define FrameQ_E_FAIL_NAMESERVERADD         -19

#define FrameQ_E_INVALID_INTERFACE          -20

#define FrameQ_E_NOTIMPLEMENTED             -21

#define FrameQ_E_OPEN_NAMESERVER            -22

#define FrameQ_E_INVALID_FRAMEQBUFMGRID     -23

#define FrameQ_E_INSUFFICENT_FRAMES         -24

#define FrameQ_E_ALLOC_MEMORY               -25

#define FrameQ_E_FRAMEQBUFMGROPEN            -26

#define FrameQ_E_LISTMPOPEN                  -27

#define FrameQ_E_CLIENTNOTIFYMGRREGCLIENT       -28

#define FrameQ_E_FRAMEQBUFMGRREGCLIENT          -29

#define FrameQ_E_CLIENTNOTIFYMGRUNREGCLIENT     -30

#define FrameQ_E_FRAMEQBUFMGRUNREGCLIENT        -31

#define FrameQ_E_ALREADYREGISTERED             -32

#define FrameQ_E_NAMESERVERADD                 -33

/* =============================================================================
 * macros & defines
 * =============================================================================
 */
#define FrameQ_FrameBufInfo       Frame_FrameBufInfo

#define FrameQ_FrameHeader        Frame_FrameHeader

typedef Frame_FrameHeader *       FrameQ_Frame;

#define FrameQ_MAX_NAMELEN                 (32u)

#define FrameQ_MAXFILLEDQUEUS_FOR_READER  (16)

#define FrameQ_MAX_INST_READERS           (2u)


#define FrameQ_MAX_INSTANCES               (64u)

#define FrameQ_NOTIFY_RESERVED_EVENTNO    (1u)

typedef UInt16                    FrameQ_NotifyMsg;

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

typedef struct FrameQ_Object * FrameQ_Handle;

typedef void (* FrameQ_NotifyFunc) (FrameQ_Handle, Ptr arg, FrameQ_NotifyMsg);

typedef enum FrameQ_NotifyType_Tag {
    FrameQ_NOTIFICATION_NONE   = SysLink_NOTIFICATION_NONE,
    FrameQ_NOTIFICATION_ALWAYS = SysLink_NOTIFICATION_ALWAYS,
    FrameQ_NOTIFICATION_ONCE   = SysLink_NOTIFICATION_ONCE,
    FrameQ_NOTIFICATION_HDWRFIFO_ALWAYS = SysLink_NOTIFICATION_HDWRFIFO_ALWAYS,
    FrameQ_NOTIFICATION_HDWRFIFO_ONCE = SysLink_NOTIFICATION_HDWRFIFO_ONCE
} FrameQ_NotifyType;

typedef enum FrameQ_OpenMode_Tag {
    FrameQ_MODE_NONE,
    FrameQ_MODE_WRITER,
    FrameQ_MODE_READER
} FrameQ_OpenMode;

typedef enum FrameQ_CpuAccessFlags_Tag {
        FrameQ_FRAMEBUF0_CPUACCESS    =  0x10000,
        FrameQ_FRAMEBUF1_CPUACCESS    =  0x20000,
        FrameQ_FRAMEBUF2_CPUACCESS    =  0x40000,
        FrameQ_FRAMEBUF3_CPUACCESS    =  0x80000,
        FrameQ_FRAMEBUF4_CPUACCESS    = 0x100000,
        FrameQ_FRAMEBUF5_CPUACCESS    = 0x200000,
        FrameQ_FRAMEBUF6_CPUACCESS    = 0x400000,
        FrameQ_FRAMEBUF7_CPUACCESS    = 0x800000
} FrameQ_CpuAccessFlags;

typedef enum FrameQ_Interface_Tag {
    FrameQ_INTERFACE_SHAREDMEM = 0x0,
    FrameQ_INTERFACE_NONE      = 0x1
} FrameQ_Interface;

typedef struct FrameQ_Config_Tag {
    UInt32 eventNo;
    UInt8  maxInstances;
    UInt32  usedefaultgate;
} FrameQ_Config;

typedef struct FrameQ_CreateParams_Tag {
    UInt32                  size;
    FrameQ_Interface        ctrlInterfaceType;
    String                  name;
    Bool                    openFlag;
    /* Open flag to indicate create/open. internal flag.  Caller should not
     * touch this flag during create
     */
} FrameQ_CreateParams;

typedef struct FrameQ_CommonOpenParams_Tag {
    String       name;
    Ptr         sharedAddr;
    UInt32      openMode;
    UInt32      cpuAccessFlags;
} FrameQ_CommonOpenParams;

typedef struct FrameQ_Params {
    FrameQ_CreateParams   commonCreateParams;
    Ptr impParams;
    UInt32  impParamsSize;
} FrameQ_Params;

typedef struct FrameQ_NotifyParams_Tag {
    FrameQ_NotifyType      notifyType;
    UInt32                  watermark;
    FrameQ_NotifyFunc       cbFxnPtr;
    Ptr                     cbContext;
    Ptr                     cbClientHandle;
} FrameQ_NotifyParams;

/* =============================================================================
 * APIs
 * =============================================================================
 */
Int32 FrameQ_isSupportedInterface(UInt32 type);

FrameQ_Handle FrameQ_create(Ptr params);

Int32 FrameQ_delete(FrameQ_Handle *pHandle);

    Int32 FrameQ_open(Ptr openParams, FrameQ_Handle *handlePtr);

Int32 FrameQ_openByAddr(FrameQ_Handle *handlePtr, Ptr openParams);

Int32 FrameQ_close(FrameQ_Handle *pHandle);

Int32 FrameQ_alloc(FrameQ_Handle handle, FrameQ_Frame *framePtr);

Int32 FrameQ_allocv(FrameQ_Handle handle, FrameQ_Frame framePtr[],
        UInt32 freeQId[], UInt8 *numFrames);

Int32 FrameQ_free(FrameQ_Handle handle, FrameQ_Frame frame);

Int32 FrameQ_freev(FrameQ_Handle handle, FrameQ_Frame framePtr[],
        UInt32 numFrames);

Int32 FrameQ_put(FrameQ_Handle handle, FrameQ_Frame frame);

Int32 FrameQ_putv(FrameQ_Handle handle, FrameQ_Frame framePtr[],
        UInt32 filledQueueId[], UInt8 numFrames);

Int32 FrameQ_get(FrameQ_Handle handle, FrameQ_Frame *framePtr);

Int32 FrameQ_getv(FrameQ_Handle handle, FrameQ_Frame pframe[],
        UInt32 filledQueueId[], UInt8 *numFrames);

Int32 FrameQ_dup(FrameQ_Handle handle, FrameQ_Frame frame,
        FrameQ_Frame *dupedFrame);

Int32 FrameQ_registerNotifier(FrameQ_Handle handle,
        FrameQ_NotifyParams *notifyParams);

Int32 FrameQ_unregisterNotifier(FrameQ_Handle handle);

Int32 FrameQ_sendNotify(FrameQ_Handle handle, UInt16 msg);

Int32 FrameQ_getNumFrames(FrameQ_Handle handle, UInt32 *numFrames);

Int32 FrameQ_getvNumFrames(FrameQ_Handle handle, UInt32 numFrames[],
        UInt8 filledQId[], UInt8 numFilledQids);

Int32 FrameQ_getNumFreeFrames(FrameQ_Handle handle, UInt32 *numFreeFrames);

Int32 FrameQ_getvNumFreeFrames(FrameQ_Handle handle, UInt32 numFreeFrames[],
        UInt8 freeQId[], UInt8 numFreeQids);

Int32 FrameQ_control(FrameQ_Handle handle, Int32 cmd, Ptr arg);

Ptr FrameQ_getExtendedHeaderPtr(FrameQ_Frame frame);


/*=============================================================================
 * Helper APIs
 *=============================================================================
 */
UInt32 FrameQ_getNumFrameBuffers(FrameQ_Frame frame);

Ptr FrameQ_getFrameBuffer(FrameQ_Frame frame, UInt32 frameBufNum);

UInt32 FrameQ_getFrameBufSize(FrameQ_Frame frame, UInt32 frameBufNum);

UInt32 FrameQ_getFrameBufValidSize(FrameQ_Frame frame, UInt32 frameBufNum);

UInt32 FrameQ_getFrameBufDataStartOffset(FrameQ_Frame frame,
        UInt32 frameBufNum);

Int32 FrameQ_setFrameBufValidSize(FrameQ_Frame frame, UInt32 frameBufNum,
        UInt32 validDataSize);

Int32 FrameQ_setFrameBufDataStartOffset(FrameQ_Frame frame,
        UInt32 frameBufNum, UInt32 dataStartOffset);


Void FrameQ_getConfig(FrameQ_Config *cfg);


Int32 FrameQ_setup(FrameQ_Config *cfg);


Int32 FrameQ_destroy(Void);


#if defined (__cplusplus)
}
#endif


#endif /*FRAMEQ_H_0x6e6f*/