interface ti.syslink.ipc.rtos.interfaces.IFrame
XDCspec summary sourced in ti/syslink/ipc/rtos/interfaces/IFrame.xdc
interface IFrame {  ...
// inherits xdc.runtime.IModule
XDCspec declarations sourced in ti/syslink/ipc/rtos/interfaces/IFrame.xdc
 
interface IFrame {
module-wide constants & types
    typedef IFrame.FrameHeader *Frame// ;
 
        UInt32 bufPtr;
        UInt32 bufSize;
        UInt32 startOffset;
        UInt32 validSize;
        UInt32 pixelFormat;
        UInt32 height;
        UInt32 width;
        UInt32 stride;
    };
 
        UInt32 reserved0;
        UInt32 reserved1;
        UInt16 baseHeaderSize;
        UInt16 headerSize;
        UInt32 frmAllocaterId;
        UInt32 frameBufType;
        UInt8 freeFrmQueueNo;
        UInt8 numFrameBuffers;
        IFrame.FrameBufInfo frameBufInfo[1];
    };
module-wide config parameters
}
 
typedef IFrame.Frame
XDCspec declarations sourced in ti/syslink/ipc/rtos/interfaces/IFrame.xdc
typedef IFrame.FrameHeader *Frame;
 
 
struct IFrame.FrameBufInfo

Structure of the framebuffer info in frame

XDCspec declarations sourced in ti/syslink/ipc/rtos/interfaces/IFrame.xdc
struct FrameBufInfo {
    UInt32 bufPtr;
    UInt32 bufSize;
    UInt32 startOffset;
    UInt32 validSize;
    UInt32 pixelFormat;
    UInt32 height;
    UInt32 width;
    UInt32 stride;
};
 
FIELDS
bufPtr — Pointer to the frame buffer.
bufSize — Size of the buffer.
startOffSet — Start offset in the buffer from where valid data starts.
validSize — Valid size in the buffer from the zeroth offset in the frame buffer.
height — Pointer to the frame buffer.
width — Size of the buffer.
stride — Multiple of page size and needs to be added to Tile start address in order to get the address starting on next row in same tile.
 
struct IFrame.FrameHeader

Structure of the base frame header. FrameQ maintains list of frames to be retrieved by FrameQ reader client. Application is expected to use Helper API to extract fileds and exteneded header pointer

XDCspec declarations sourced in ti/syslink/ipc/rtos/interfaces/IFrame.xdc
struct FrameHeader {
    UInt32 reserved0;
    UInt32 reserved1;
    UInt16 baseHeaderSize;
    UInt16 headerSize;
    UInt32 frmAllocaterId;
    UInt32 frameBufType;
    UInt8 freeFrmQueueNo;
    UInt8 numFrameBuffers;
    IFrame.FrameBufInfo frameBufInfo[1];
};
 
FIELDS
baseHeaderSize — Size of the base frame header.
headerSize — Size of the frame header(total size of base header and extended header).
frmAllocaterId — Denotes the FrameQBufMgr Id from which frame is allocated.
freeFrmQueueNo — Free quque No from which frame is allocated in FrameQBufMgr.
numFrameBuffers — Number of framebuffers in a frame.
frameBufInfo — Information of Frame buffer. FrameBufInfo
 
metaonly config IFrame.common$  // module-wide

Common module configuration parameters

XDCspec declarations sourced in ti/syslink/ipc/rtos/interfaces/IFrame.xdc
metaonly config Types.Common$ common$;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
generated on Mon, 08 Aug 2011 21:02:25 GMT