RDK-B
Data Structures | Macros | Typedefs | Enumerations
EMMC HAL Data Types
EMMC HAL

Description

Data Structures

struct  _stmgr_DeviceIds
 
struct  _stmgr_DeviceInfo
 
struct  _stmgr_DeviceInfos
 
struct  _stmgr_PartitionInfo
 
struct  _stmgr_DiagnosticsAttributes
 
struct  _stmgr_DiagnosticsAttributeList
 
struct  _stmgr_Health
 
struct  _stmgr_EventMessage
 
struct  _stmgr_CallBackData
 

Macros

#define RDK_STMGR_MAX_DEVICES   10
 
#define RDK_STMGR_MAX_STRING_LENGTH   128
 
#define RDK_STMGR_PARTITION_LENGTH   256
 
#define RDK_STMGR_DIAGNOSTICS_LENGTH   256
 
#define RDK_STMGR_DIAGNOSTICS_BLOB_LENGTH   2048
 
#define RDK_STMGR_MAX_DIAGNOSTIC_ATTRIBUTES   20
 

Typedefs

typedef enum _stmgr_ReturnCode eSTMGRReturns
 
typedef enum _stmgr_DeviceType eSTMGRDeviceType
 
typedef enum _stmgr_DeviceStatus eSTMGRDeviceStatus
 
typedef enum _stmgr_events eSTMGREvents
 
typedef struct _stmgr_DeviceIds eSTMGRDeviceIDs
 
typedef struct _stmgr_DeviceInfo eSTMGRDeviceInfo
 
typedef struct _stmgr_DeviceInfos eSTMGRDeviceInfoList
 
typedef struct _stmgr_PartitionInfo eSTMGRPartitionInfo
 
typedef struct _stmgr_DiagnosticsAttributes eSTMGRDiagAttributes
 
typedef struct _stmgr_DiagnosticsAttributeList eSTMGRDiagAttributesList
 
typedef struct _stmgr_Health eSTMGRHealthInfo
 
typedef struct _stmgr_EventMessage eSTMGREventMessage
 
typedef struct _stmgr_CallBackData eSTMGRCallBackData
 

Enumerations

enum  _stmgr_ReturnCode {
  RDK_STMGR_RETURN_SUCCESS = 0, RDK_STMGR_RETURN_GENERIC_FAILURE = -1, RDK_STMGR_RETURN_INIT_FAILURE = -2, RDK_STMGR_RETURN_INVALID_INPUT = -3,
  RDK_STMGR_RETURN_UNKNOWN_FAILURE = -4
}
 
enum  _stmgr_DeviceType {
  RDK_STMGR_DEVICE_TYPE_HDD = 0, RDK_STMGR_DEVICE_TYPE_SDCARD, RDK_STMGR_DEVICE_TYPE_USB, RDK_STMGR_DEVICE_TYPE_FLASH,
  RDK_STMGR_DEVICE_TYPE_NVRAM, RDK_STMGR_DEVICE_TYPE_EMMCCARD, RDK_STMGR_DEVICE_TYPE_MAX
}
 
enum  _stmgr_DeviceStatus {
  RDK_STMGR_DEVICE_STATUS_OK = 0, RDK_STMGR_DEVICE_STATUS_READ_ONLY = (1 << 0), RDK_STMGR_DEVICE_STATUS_NOT_PRESENT = (1 << 1), RDK_STMGR_DEVICE_STATUS_NOT_QUALIFIED = (1 << 2),
  RDK_STMGR_DEVICE_STATUS_DISK_FULL = (1 << 3), RDK_STMGR_DEVICE_STATUS_READ_FAILURE = (1 << 4), RDK_STMGR_DEVICE_STATUS_WRITE_FAILURE = (1 << 5), RDK_STMGR_DEVICE_STATUS_UNKNOWN = (1 << 6)
}
 
enum  _stmgr_events { RDK_STMGR_EVENT_STATUS_CHANGED = 100, RDK_STMGR_EVENT_HEALTH_WARNING, RDK_STMGR_EVENT_DEVICE_FAILURE }
 

Data Structure Documentation

◆ _stmgr_DeviceIds

struct _stmgr_DeviceIds

Definition at line 113 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_DeviceIds:
Collaboration graph

Data Fields

unsigned short m_numOfDevices
 
char m_deviceIDs [10][128]
 

Field Documentation

◆ m_numOfDevices

unsigned short _stmgr_DeviceIds::m_numOfDevices

Definition at line 114 of file ccsp_hal_emmc.h.

◆ m_deviceIDs

char _stmgr_DeviceIds::m_deviceIDs[10][128]

Definition at line 115 of file ccsp_hal_emmc.h.

◆ _stmgr_DeviceInfo

struct _stmgr_DeviceInfo

Definition at line 118 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_DeviceInfo:
Collaboration graph

Data Fields

char m_deviceID [128]
 
eSTMGRDeviceType m_type
 
unsigned long long m_capacity
 
eSTMGRDeviceStatus m_status
 
char m_partitions [256]
 
char m_manufacturer [128]
 
char m_model [128]
 
char m_serialNumber [128]
 
char m_firmwareVersion [128]
 
char m_hwVersion [128]
 
char m_ifATAstandard [128]
 
bool m_hasSMARTSupport
 

Field Documentation

◆ m_deviceID

char _stmgr_DeviceInfo::m_deviceID[128]

Definition at line 119 of file ccsp_hal_emmc.h.

◆ m_type

eSTMGRDeviceType _stmgr_DeviceInfo::m_type

Definition at line 120 of file ccsp_hal_emmc.h.

◆ m_capacity

unsigned long long _stmgr_DeviceInfo::m_capacity

Definition at line 121 of file ccsp_hal_emmc.h.

◆ m_status

eSTMGRDeviceStatus _stmgr_DeviceInfo::m_status

Definition at line 122 of file ccsp_hal_emmc.h.

◆ m_partitions

char _stmgr_DeviceInfo::m_partitions[256]

Definition at line 123 of file ccsp_hal_emmc.h.

◆ m_manufacturer

char _stmgr_DeviceInfo::m_manufacturer[128]

Definition at line 124 of file ccsp_hal_emmc.h.

◆ m_model

char _stmgr_DeviceInfo::m_model[128]

Definition at line 125 of file ccsp_hal_emmc.h.

◆ m_serialNumber

char _stmgr_DeviceInfo::m_serialNumber[128]

Definition at line 126 of file ccsp_hal_emmc.h.

◆ m_firmwareVersion

char _stmgr_DeviceInfo::m_firmwareVersion[128]

Definition at line 127 of file ccsp_hal_emmc.h.

◆ m_hwVersion

char _stmgr_DeviceInfo::m_hwVersion[128]

Definition at line 128 of file ccsp_hal_emmc.h.

◆ m_ifATAstandard

char _stmgr_DeviceInfo::m_ifATAstandard[128]

Definition at line 129 of file ccsp_hal_emmc.h.

◆ m_hasSMARTSupport

bool _stmgr_DeviceInfo::m_hasSMARTSupport

Definition at line 130 of file ccsp_hal_emmc.h.

◆ _stmgr_DeviceInfos

struct _stmgr_DeviceInfos

Definition at line 133 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_DeviceInfos:
Collaboration graph

Data Fields

unsigned short m_numOfDevices
 
eSTMGRDeviceInfo m_devices [10]
 

Field Documentation

◆ m_numOfDevices

unsigned short _stmgr_DeviceInfos::m_numOfDevices

Definition at line 134 of file ccsp_hal_emmc.h.

◆ m_devices

eSTMGRDeviceInfo _stmgr_DeviceInfos::m_devices[10]

Definition at line 135 of file ccsp_hal_emmc.h.

◆ _stmgr_PartitionInfo

struct _stmgr_PartitionInfo

Definition at line 138 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_PartitionInfo:
Collaboration graph

Data Fields

char m_partitionId [128]
 
char m_name [128]
 
char m_mountPath [128]
 
char m_format [128]
 
eSTMGRDeviceStatus m_status
 
unsigned long long m_capacity
 
unsigned long long m_freeSpace
 
bool m_isTSBSupported
 
bool m_isDVRSupported
 

Field Documentation

◆ m_partitionId

char _stmgr_PartitionInfo::m_partitionId[128]

Definition at line 139 of file ccsp_hal_emmc.h.

◆ m_name

char _stmgr_PartitionInfo::m_name[128]

Definition at line 140 of file ccsp_hal_emmc.h.

◆ m_mountPath

char _stmgr_PartitionInfo::m_mountPath[128]

Definition at line 141 of file ccsp_hal_emmc.h.

◆ m_format

char _stmgr_PartitionInfo::m_format[128]

Definition at line 142 of file ccsp_hal_emmc.h.

◆ m_status

eSTMGRDeviceStatus _stmgr_PartitionInfo::m_status

Definition at line 143 of file ccsp_hal_emmc.h.

◆ m_capacity

unsigned long long _stmgr_PartitionInfo::m_capacity

Definition at line 144 of file ccsp_hal_emmc.h.

◆ m_freeSpace

unsigned long long _stmgr_PartitionInfo::m_freeSpace

Definition at line 145 of file ccsp_hal_emmc.h.

◆ m_isTSBSupported

bool _stmgr_PartitionInfo::m_isTSBSupported

Definition at line 146 of file ccsp_hal_emmc.h.

◆ m_isDVRSupported

bool _stmgr_PartitionInfo::m_isDVRSupported

Definition at line 147 of file ccsp_hal_emmc.h.

◆ _stmgr_DiagnosticsAttributes

struct _stmgr_DiagnosticsAttributes

Definition at line 150 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_DiagnosticsAttributes:
Collaboration graph

Data Fields

char m_name [128]
 
char m_value [128]
 

Field Documentation

◆ m_name

char _stmgr_DiagnosticsAttributes::m_name[128]

Gives SMART diagnostics attributes name.

Definition at line 151 of file ccsp_hal_emmc.h.

◆ m_value

char _stmgr_DiagnosticsAttributes::m_value[128]

Gives SMART diagnostics attributes value, Comma separated.

Definition at line 152 of file ccsp_hal_emmc.h.

◆ _stmgr_DiagnosticsAttributeList

struct _stmgr_DiagnosticsAttributeList

Definition at line 155 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_DiagnosticsAttributeList:
Collaboration graph

Data Fields

unsigned short m_numOfAttributes
 
eSTMGRDiagAttributes m_diagnostics [20]
 

Field Documentation

◆ m_numOfAttributes

unsigned short _stmgr_DiagnosticsAttributeList::m_numOfAttributes

Definition at line 156 of file ccsp_hal_emmc.h.

◆ m_diagnostics

eSTMGRDiagAttributes _stmgr_DiagnosticsAttributeList::m_diagnostics[20]

Definition at line 157 of file ccsp_hal_emmc.h.

◆ _stmgr_Health

struct _stmgr_Health

Definition at line 160 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_Health:
Collaboration graph

Data Fields

char m_deviceID [128]
 
eSTMGRDeviceType m_deviceType
 
bool m_isOperational
 
bool m_isHealthy
 
union {
   eSTMGRDiagAttributesList   m_list
 
   char   m_blob [2048]
 
} m_diagnostics
 
eSTMGRDiagAttributesList m_lifetimesList
 
eSTMGRDiagAttributesList m_firstExceededConfiguredLife
 
eSTMGRDiagAttributesList m_firstExceededMaxLife
 
eSTMGRDiagAttributesList m_healthStatesList
 

Field Documentation

◆ m_deviceID

char _stmgr_Health::m_deviceID[128]

Definition at line 161 of file ccsp_hal_emmc.h.

◆ m_deviceType

eSTMGRDeviceType _stmgr_Health::m_deviceType

Definition at line 162 of file ccsp_hal_emmc.h.

◆ m_isOperational

bool _stmgr_Health::m_isOperational

Definition at line 163 of file ccsp_hal_emmc.h.

◆ m_isHealthy

bool _stmgr_Health::m_isHealthy

Definition at line 164 of file ccsp_hal_emmc.h.

◆ m_list

eSTMGRDiagAttributesList _stmgr_Health::m_list

Definition at line 166 of file ccsp_hal_emmc.h.

◆ m_blob

char _stmgr_Health::m_blob[2048]

Definition at line 167 of file ccsp_hal_emmc.h.

◆ m_diagnostics

union { ... } _stmgr_Health::m_diagnostics

◆ m_lifetimesList

eSTMGRDiagAttributesList _stmgr_Health::m_lifetimesList

Definition at line 169 of file ccsp_hal_emmc.h.

◆ m_firstExceededConfiguredLife

eSTMGRDiagAttributesList _stmgr_Health::m_firstExceededConfiguredLife

Definition at line 170 of file ccsp_hal_emmc.h.

◆ m_firstExceededMaxLife

eSTMGRDiagAttributesList _stmgr_Health::m_firstExceededMaxLife

Definition at line 171 of file ccsp_hal_emmc.h.

◆ m_healthStatesList

eSTMGRDiagAttributesList _stmgr_Health::m_healthStatesList

Definition at line 172 of file ccsp_hal_emmc.h.

◆ _stmgr_EventMessage

struct _stmgr_EventMessage

Definition at line 175 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_EventMessage:
Collaboration graph

Data Fields

eSTMGREvents m_eventType
 
char m_deviceID [128]
 
eSTMGRDeviceType m_deviceType
 
eSTMGRDeviceStatus m_deviceStatus
 
char m_description [128]
 
char m_diagnostics [256]
 

Field Documentation

◆ m_eventType

eSTMGREvents _stmgr_EventMessage::m_eventType

Definition at line 176 of file ccsp_hal_emmc.h.

◆ m_deviceID

char _stmgr_EventMessage::m_deviceID[128]

Definition at line 177 of file ccsp_hal_emmc.h.

◆ m_deviceType

eSTMGRDeviceType _stmgr_EventMessage::m_deviceType

Definition at line 178 of file ccsp_hal_emmc.h.

◆ m_deviceStatus

eSTMGRDeviceStatus _stmgr_EventMessage::m_deviceStatus

Definition at line 179 of file ccsp_hal_emmc.h.

◆ m_description

char _stmgr_EventMessage::m_description[128]

Definition at line 180 of file ccsp_hal_emmc.h.

◆ m_diagnostics

char _stmgr_EventMessage::m_diagnostics[256]

Definition at line 181 of file ccsp_hal_emmc.h.

◆ _stmgr_CallBackData

struct _stmgr_CallBackData

Definition at line 184 of file ccsp_hal_emmc.h.

Collaboration diagram for _stmgr_CallBackData:
Collaboration graph

Data Fields

bool isSDCard
 
char mountPath [200]
 

Field Documentation

◆ isSDCard

bool _stmgr_CallBackData::isSDCard

Definition at line 185 of file ccsp_hal_emmc.h.

◆ mountPath

char _stmgr_CallBackData::mountPath[200]

Definition at line 186 of file ccsp_hal_emmc.h.

Macro Definition Documentation

◆ RDK_STMGR_MAX_DEVICES

#define RDK_STMGR_MAX_DEVICES   10

Definition at line 50 of file ccsp_hal_emmc.h.

◆ RDK_STMGR_MAX_STRING_LENGTH

#define RDK_STMGR_MAX_STRING_LENGTH   128

Definition at line 51 of file ccsp_hal_emmc.h.

◆ RDK_STMGR_PARTITION_LENGTH

#define RDK_STMGR_PARTITION_LENGTH   256

Definition at line 52 of file ccsp_hal_emmc.h.

◆ RDK_STMGR_DIAGNOSTICS_LENGTH

#define RDK_STMGR_DIAGNOSTICS_LENGTH   256

Definition at line 53 of file ccsp_hal_emmc.h.

◆ RDK_STMGR_DIAGNOSTICS_BLOB_LENGTH

#define RDK_STMGR_DIAGNOSTICS_BLOB_LENGTH   2048

Definition at line 54 of file ccsp_hal_emmc.h.

◆ RDK_STMGR_MAX_DIAGNOSTIC_ATTRIBUTES

#define RDK_STMGR_MAX_DIAGNOSTIC_ATTRIBUTES   20

Max Number of SMART diagnostics attributes.

Definition at line 55 of file ccsp_hal_emmc.h.

Typedef Documentation

◆ eSTMGRReturns

typedef enum _stmgr_ReturnCode eSTMGRReturns

◆ eSTMGRDeviceType

typedef enum _stmgr_DeviceType eSTMGRDeviceType

◆ eSTMGRDeviceStatus

typedef enum _stmgr_DeviceStatus eSTMGRDeviceStatus

◆ eSTMGREvents

typedef enum _stmgr_events eSTMGREvents

◆ eSTMGRDeviceIDs

typedef struct _stmgr_DeviceIds eSTMGRDeviceIDs

◆ eSTMGRDeviceInfo

typedef struct _stmgr_DeviceInfo eSTMGRDeviceInfo

◆ eSTMGRDeviceInfoList

typedef struct _stmgr_DeviceInfos eSTMGRDeviceInfoList

◆ eSTMGRPartitionInfo

typedef struct _stmgr_PartitionInfo eSTMGRPartitionInfo

◆ eSTMGRDiagAttributes

typedef struct _stmgr_DiagnosticsAttributes eSTMGRDiagAttributes

◆ eSTMGRDiagAttributesList

typedef struct _stmgr_DiagnosticsAttributeList eSTMGRDiagAttributesList

◆ eSTMGRHealthInfo

typedef struct _stmgr_Health eSTMGRHealthInfo

◆ eSTMGREventMessage

typedef struct _stmgr_EventMessage eSTMGREventMessage

◆ eSTMGRCallBackData

typedef struct _stmgr_CallBackData eSTMGRCallBackData

Enumeration Type Documentation

◆ _stmgr_ReturnCode

enum _stmgr_ReturnCode
Enumerator
RDK_STMGR_RETURN_SUCCESS 
RDK_STMGR_RETURN_GENERIC_FAILURE 
RDK_STMGR_RETURN_INIT_FAILURE 
RDK_STMGR_RETURN_INVALID_INPUT 
RDK_STMGR_RETURN_UNKNOWN_FAILURE 

Definition at line 63 of file ccsp_hal_emmc.h.

◆ _stmgr_DeviceType

enum _stmgr_DeviceType
Enumerator
RDK_STMGR_DEVICE_TYPE_HDD 
RDK_STMGR_DEVICE_TYPE_SDCARD 
RDK_STMGR_DEVICE_TYPE_USB 
RDK_STMGR_DEVICE_TYPE_FLASH 
RDK_STMGR_DEVICE_TYPE_NVRAM 
RDK_STMGR_DEVICE_TYPE_EMMCCARD 
RDK_STMGR_DEVICE_TYPE_MAX 

Definition at line 76 of file ccsp_hal_emmc.h.

◆ _stmgr_DeviceStatus

enum _stmgr_DeviceStatus
Enumerator
RDK_STMGR_DEVICE_STATUS_OK 
RDK_STMGR_DEVICE_STATUS_READ_ONLY 
RDK_STMGR_DEVICE_STATUS_NOT_PRESENT 
RDK_STMGR_DEVICE_STATUS_NOT_QUALIFIED 
RDK_STMGR_DEVICE_STATUS_DISK_FULL 
RDK_STMGR_DEVICE_STATUS_READ_FAILURE 
RDK_STMGR_DEVICE_STATUS_WRITE_FAILURE 
RDK_STMGR_DEVICE_STATUS_UNKNOWN 

Definition at line 91 of file ccsp_hal_emmc.h.

◆ _stmgr_events

enum _stmgr_events
Enumerator
RDK_STMGR_EVENT_STATUS_CHANGED 
RDK_STMGR_EVENT_HEALTH_WARNING 
RDK_STMGR_EVENT_DEVICE_FAILURE 

Definition at line 107 of file ccsp_hal_emmc.h.