RDK Documentation (Open Sourced RDK Components)
Data Structures | Macros | Typedefs | Enumerations
mfrMgr.h File Reference

IARM-Bus MFR Manager Public API. More...

#include "libIBus.h"
#include "libIARM.h"
#include "mfrTypes.h"
Include dependency graph for mfrMgr.h:

Go to the source code of this file.

Data Structures

struct  _IARM_Bus_MFRLib_SerializedData_Param_t
 
struct  _IARM_Bus_MFRLib_WriteImage_Param_t
 
struct  _IARM_Bus_MFRLib_GetImageWriteProgress_Param_t
 
struct  _IARM_Bus_MFRLib_SetImageWriteProgress_Param_t
 
struct  _IARM_Bus_MFRLib_Reboot_Param_t
 
struct  _IARM_Bus_MFRLib_SetCableCardType_Param_t
 
struct  _IARM_Bus_MFRLib_SetHostFirmwareInfo_Param_t
 
struct  _IARM_Bus_MFRLib_GetBootImageName_Param_t
 
struct  _IARM_Bus_MFRLib_GetPathConfiguration_Param_t
 
struct  _IARM_Bus_MFRLib_GetDFAST2Data_Param_t
 
struct  _IARM_Bus_MFRLib_CommonAPI_WriteImageCb_Param_t
 
struct  _IARM_BUS_MfrMgr_StatusUpdate_EventData_t
 

Macros

#define IARM_BUS_MFRLIB_NAME   "MFRLib"
 
#define IARM_BUS_MFRLIB_API_GetSerializedData   "mfrGetSerializedData"
 
#define IARM_BUS_MFRLIB_API_SetSerializedData   "mfrSetSerializedData"
 
#define IARM_BUS_MFRLIB_API_WriteImage   "mfrWriteImage"
 
#define IARM_BUS_MFRLIB_API_SetImageWriteProgress   "mfrSetImageWriteProgress"
 
#define IARM_BUS_MFRLIB_API_GetImageWriteProgress   "mfrGetImageWriteProgress"
 
#define IARM_BUS_MFRLIB_API_DeletePDRI   "mfrDeletePDRI"
 
#define IARM_BUS_MFRLIB_API_ScrubAllBanks   "mfrScrubAllBanks"
 
#define IARM_BUS_MFRLIB_API_Reboot   "mfrReboot"
 
#define IARM_BUS_MFRLIB_API_SetCableCardType   "mfrSetCableCardType"
 
#define IARM_BUS_MFRLIB_API_SetHostFirmwareInfo   "mfrSetHostFirmwareInfo"
 
#define IARM_BUS_MFRLIB_API_GetBootImageName   "mfrGetBootImageName"
 
#define IARM_BUS_MFRLIB_API_GetPathConfiguration   "mfrGetPathConfiguration"
 
#define IARM_BUS_MFRLIB_API_GetDFAST2Data   "mfrGetDFAST2Data"
 
#define IARM_BUS_MFRLIB_COMMON_API_WriteImageCb   "WriteImageCb"
 
#define IARM_BUS_MFRLIB_API_Init   "mfrInit"
 
#define IARM_BUS_MFRLIB_API_Shutdown   "mfrShutdown"
 
#define MAX_BUF   255
 
#define MAX_SERIALIZED_BUF   1280
 

Typedefs

typedef struct _IARM_Bus_MFRLib_SerializedData_Param_t IARM_Bus_MFRLib_SerializedData_Param_t
 
typedef struct _IARM_Bus_MFRLib_WriteImage_Param_t IARM_Bus_MFRLib_WriteImage_Param_t
 
typedef struct _IARM_Bus_MFRLib_GetImageWriteProgress_Param_t IARM_Bus_MFRLib_GetImageWriteProgress_Param_t
 
typedef struct _IARM_Bus_MFRLib_SetImageWriteProgress_Param_t IARM_Bus_MFRLib_SetImageWriteProgress_Param_t
 
typedef struct _IARM_Bus_MFRLib_Reboot_Param_t IARM_Bus_MFRLib_Reboot_Param_t
 
typedef struct _IARM_Bus_MFRLib_SetCableCardType_Param_t IARM_Bus_MFRLib_SetCableCardType_Param_t
 
typedef struct _IARM_Bus_MFRLib_SetHostFirmwareInfo_Param_t IARM_Bus_MFRLib_SetHostFirmwareInfo_Param_t
 
typedef struct _IARM_Bus_MFRLib_GetBootImageName_Param_t IARM_Bus_MFRLib_GetBootImageName_Param_t
 
typedef struct _IARM_Bus_MFRLib_GetPathConfiguration_Param_t IARM_Bus_MFRLib_GetPathConfiguration_Param_t
 
typedef struct _IARM_Bus_MFRLib_GetDFAST2Data_Param_t IARM_Bus_MFRLib_GetDFAST2Data_Param_t
 
typedef struct _IARM_Bus_MFRLib_CommonAPI_WriteImageCb_Param_t IARM_Bus_MFRLib_CommonAPI_WriteImageCb_Param_t
 
typedef enum _MfrMgr_EventId_t IARM_Bus_MfrMgr_EventId_t
 
typedef struct _IARM_BUS_MfrMgr_StatusUpdate_EventData_t IARM_BUS_MfrMgr_StatusUpdate_EventData_t
 

Enumerations

enum  _MfrMgr_EventId_t
 

yes

IARM-Bus MFR Manager Public API.

This API defines the operations for the IARM-Bus MFR Manager interface.

Document
Document reference.
Open Issues (in no particular order)
  1. None
Assumptions
  1. None
Abbreviations
  • BE: ig-Endian.
  • cb: allback function (suffix).
  • DS: Device Settings.
  • FPD: Front-Panel Display.
  • HAL: Hardware Abstraction Layer.
  • LE: Little-Endian.
  • LS: Least Significant.
  • MBZ: Must be zero.
  • MS: Most Significant.
  • RDK: Reference Design Kit.
  • _t: Type (suffix).
Implementation Notes
  1. None

Definition in file mfrMgr.h.