tmdlfgpo.h

PNX1500上视频输出VCP的源代码

// DESCRIPTION: Get the Fgpo DevLib interface compatiblity number, major version
//              and minor version.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       None.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_GetSWVersion(
              ptmSWVersion_t pFgpoVersionInfo);  // O: Fgpo Version Info pointer


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_GetCapabilities:
//
// DESCRIPTION: This function returns the capabilites of Fgpo Unit tmUnit0.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       See defintion of the structure tmdlFgpoCapabilities_t for more
//              details.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_GetCapabilities(
                    const tmdlFgpo_Capabilities_t(**ppFgpoCaps));  // O: Fgpo capabilites ptr ptr


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_GetCapabilitiesM:
//
// DESCRIPTION: This function returns the capabilites of Fgpo Unit fgpoUnitID.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       See defintion of the structure tmdlFgpoCapabilities_t for more
//              details.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_GetCapabilitiesM(
                    const tmdlFgpo_Capabilities_t(**ppFgpoCaps),  // O: Fgpo capabilites ptr ptr
                    tmUnitSelect_t fgpoUnitID);                   // I: Fgpo Unit Number


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_Open:
//
// DESCRIPTION: This function opens Fgpo Unit tmUnit0 for access
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       The Fgpo Instance returned from the function will be passed in 
//              as a parameter in subsequent device library function calls.
//              Use the tmdlFgpo_Close function to close the Fgpo instance and
//              free system resources after all Fgpo instance access have been
//              completed.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_Open(
    tmInstance_t *pFgpoInstance);  // O: Fgpo instance for access.


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_OpenM:
//
// DESCRIPTION: This function opens Fgpo Unit fgpoUnitID for access
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       The Fgpo Instance returned from the function will be passed in 
//              as a parameter in subsequent device library function calls.
//              Use the tmdlFgpo_Close function to close the Fgpo instance and
//              free system resources after all Fgpo instance access have been
//              completed.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_OpenM(
    tmInstance_t *pFgpoInstance,  // O: Fgpo instance for access.
    tmUnitSelect_t fgpoUnitID);   // I: Fgpo Unit Number


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_Close:
//
// DESCRIPTION: This function deallocates the specified Fgpo instance created by
//              tmdlFgpo_Open.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       Any active Fgpo software or hardware operations will be 
//              disabled. After the Fgpo instance is closed, the instance 
//              number is no longer valid and cannot be used for device
//              library function calls.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_Close(
                   tmInstance_t fgpoInstance);  // I: Fgpo Instance to close.
 

//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_GetInstanceSetup:
//
// DESCRIPTION: get current setup or default setup if not initialized.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       None.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_GetInstanceSetup(
              tmInstance_t              fgpoInstance,   //  I: instance  
              ptmdlFgpo_InstanceSetup_t *ppFgpoSetup);  //  O: ptr to instance setup struct ptr


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_InstanceSetup:
//
// DESCRIPTION: setup the Fgpo instance
//              
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       None.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_InstanceSetup(
                tmInstance_t              fgpoInstance,  // I: instance  
                ptmdlFgpo_InstanceSetup_t pFgpoSetup);   // I: ptr to new setup structure


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_InstanceConfig:
//
// DESCRIPTION: This function configures the Fgpo instance based on the
//              specific Fgpo configuration command and the associated
//              data structure.
//
// RETURN:      TM_OK -->if command is supported 
//			  TMDL_ERR_FGPO_NOT_SUPPORTED  --> if command is not supported
//
// NOTES:       There currently only two runtime configurable parameters in the FGPO
//           	  Device Library.  It will return TM_OK, if one of these commands are asked to set.
//                   Otherwise it will return TMDL_ERR_FGPO_NOT_SUPPORTED		 
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_InstanceConfig(
                 tmInstance_t fgpoInstance,  // I: Fgpo Instance to configure.
                 UInt32       fgpoCfgCmd,    // I: Fgpo instance configuration command.
                 pVoid        fgpoCfgData);  // I: Fgpo instance configuration data.


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_Start:
//
// DESCRIPTION: This function starts the Fgpo instance.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       This function may only be called after tmdlFgpo_RegisterCallback,
//              tmdlFgpo_SetEventMask and tmdlFgpo_InstanceSetup has been called.
//
//              Set FGPI_CTL/CAPTURE_ENABLE_1 or CAPTURE_ENABLE_2
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_Start(
                    tmInstance_t fgpoInstance);  // I: Fgpo Instance to start.


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_Stop:
//
// DESCRIPTION: This function stops the Fgpo instance.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       This function may only be called after a tmdlFgpo_Start has been
//              called.
//
//              Reset FGPI_CTL/CAPTURE_ENABLE_1 or CAPTURE_ENABLE_2
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_Stop(
              tmInstance_t fgpoInstance);  // I: Fgpo Instance to stop.


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_RegisterCallback:
//
// DESCRIPTION: This Function allows the user to register callback function for
//              given events.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       There is only one register callback function per instance.
//
//              This function should be called for the first time before
//              the function tmdlFgpo_Start.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_RegisterCallback(
                 tmInstance_t  fgpoInstance,   // I: Fgpo Instance
                 ptmCallback_t pFgpoCallBack,  // I: callback function pointer
                 UInt32        fgpoUserData);  // I: user data


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_SetEventMask:
//
// DESCRIPTION: This Function allows the user to select the FGPO events that
//              needs to be notified and handled by the callback function.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       All events are disabled by default. If all events are disabled
//              the callback function will be disabled by default.
//
//              This function should be called for the first time before the
//              function tmdlFgpo_Start.
//
//              This function is only usable if the corresponding
//              tmdlFgpo_RegisterCallback function has been called with a
//              non-Null callback function pointer.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_SetEventMask(
                    tmInstance_t fgpoInstance,    // I: Fgpo Instance
                    UInt32       fgpoEventMask);  // I: A bit wise OR of the events when the
                                                  //    callback function should be called.


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_GetNumOfRec:
//
// DESCRIPTION: This function retrieves the number of completed records or messages output.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       This function can be called in ISR.
//              Calling this function while the associated buffer is active may not 
//              return the actual transfer count( can be less than or equal to the 
//              actual count) due to clock domain crossing.  The best time to retrieve 
//              the transfer count is during the associated BUFnFULL isr as the counter 
//              is not updated during this time.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_GetNumOfRec(
                tmInstance_t fgpoInstance,    // I: Fgpo Instance
                UInt8        fgpoBufIndex,    // I: the index of the buffer, value could be 1 or 2
                pUInt32      pFgpoNumOfRec);  // O: the number of completed records or messages output


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_GetTimestamp:
//
// DESCRIPTION: This function gets the timestamp when a buffer is done.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       This function can be called in ISR.       
//
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_GetTimestamp(
                 tmInstance_t fgpoInstance,     // I: Fgpo Instance
                 UInt8        fgpoBufIndex,     // I: the index of the buffer, value could be 1 or 2
                 pUInt32      pFgpoTimestamp);  // O: the timestamp


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_ChangeBuffer:
//
// DESCRIPTION: This function changes the buffer that the FGPO instance uses.
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       This function can be called in ISR.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_ChangeBuffer(
                 tmInstance_t fgpoInstance,  // I: Fgpo Instance
                 UInt8        fgpoBufIndex,  // I: the index of the buffer to change, value could be 1 or 2
                 UInt32       fgpoBufAddr);  // I: the physical address of the new buffer


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_SetPowerState:
//
// DESCRIPTION: This function set the fgpo instance power state
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       None.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_SetPowerState(
    tmInstance_t   fgpoInstance,     // I: Fgpo Instance ID
    tmPowerState_t fgpoPowerState);  // I: Fgpo power state to enter


//-----------------------------------------------------------------------------
// FUNCTION:    tmdlFgpo_GetPowerState:
//
// DESCRIPTION: This function gets the fgpo instance power state
//
// RETURN:      tmErrorCode_t: Status of operation (TM_OK = PASS)
//
// NOTES:       None.
//-----------------------------------------------------------------------------
//
tmErrorCode_t tmdlFgpo_GetPowerState(
                  tmInstance_t    fgpoInstance,      // I: Fgpo Instance ID
                  ptmPowerState_t pFgpoPowerState);  // O: Fgpo power state pointer

 
#ifdef __cplusplus
}
#endif

#endif // _TMDLFGPO_H_ //------------------