RDK Documentation (Open Sourced RDK Components)
Macros | Typedefs | Enumerations
Device Settings HAL Front Panel Display (FPD) Type Definitions
DevicesettingsIARM-Sys Manager internal API. | IARM-Disk Manager internal API. | IARM-Disk Manager API. | IARM-Bus IR Manager API. | IARM-MFR Manager API | IARM-Sys Manager internal API. | IARM-VREX Manager API. » | Iarmmgrs » HalDevice Settings Module » Device Settings HAL Types & Public API » Device Settings HAL Data Types » | Device Settings HAL Front Panel Display Types

Description

Macros

#define dsFPDColor_Make(R8, G8, B8)   (((R8)<<16) | ((G8)<< 8) | ((B8) ))
 
#define dsFPDColor_R(RGB32)   (((RGB32) >> 16) & 0xFF)
 
#define dsFPDColor_G(RGB32)   (((RGB32) >> 8) & 0xFF)
 
#define dsFPDColor_B(RGB32)   (((RGB32) ) & 0xFF)
 
#define dsFPD_COLOR_BLUE   dsFPDColor_Make(0, 0, 0xFF)
 
#define dsFPD_COLOR_GREEN   dsFPDColor_Make(0, 0xFF, 0)
 
#define dsFPD_COLOR_RED   dsFPDColor_Make(0xFF, 0, 0x0)
 
#define dsFPD_COLOR_YELLOW   dsFPDColor_Make(0xFF, 0xFF, 0xE0)
 
#define dsFPD_COLOR_ORANGE   dsFPDColor_Make(0xFF, 0x8C, 0x00)
 
#define dsFPD_COLOR_WHITE   dsFPDColor_Make(0xFF, 0xFF, 0xFF)
 
#define dsFPD_COLOR_MAX   6
 
#define dsFPDColor_isValid(t)   (((t) & 0xFF000000) == 0)
 
#define dsFPD_INDICATOR_MESSAGE   0
 
#define dsFPD_INDICATOR_POWER   1
 
#define dsFPD_INDICATOR_RECORD   2
 
#define dsFPD_INDICATOR_REMOTE   3
 
#define dsFPD_INDICATOR_RFBYPASS   4
 
#define dsFPD_INDICATOR_MAX   5
 
#define dsFPDIndicator_isValid(t)   (true)
 
#define dsFPDTextDisplay_isValid(t)   (((t) >= dsFPD_TEXTDISP_TEXT ) && ((t) < dsFPD_TEXTDISP_MAX))
 
#define dsFPD_BRIGHTNESS_MAX   100
 

Typedefs

typedef uint32_t dsFPDColor_t
 
typedef int32_t dsFPDIndicator_t
 
typedef enum __dsFPDTextDisplay_t dsFPDTextDisplay_t
 
typedef enum __dsFPDState_t dsFPDState_t
 
typedef enum __dsFPDLedState_t dsFPDLedState_t
 
typedef enum __dsFPDTimeFormat_t dsFPDTimeFormat_t
 
typedef uint32_t dsFPDBrightness_t
 
typedef enum __dsFPDMode_t dsFPDMode_t
 

Enumerations

enum  __dsFPDTextDisplay_t
 
enum  __dsFPDState_t
 
enum  __dsFPDLedState_t
 
enum  __dsFPDTimeFormat_t
 
enum  __dsFPDMode_t
 

Macro Definition Documentation

◆ dsFPD_COLOR_BLUE

#define dsFPD_COLOR_BLUE   dsFPDColor_Make(0, 0, 0xFF)

Blue color LED.

Definition at line 765 of file dsTypes.h.

◆ dsFPD_COLOR_GREEN

#define dsFPD_COLOR_GREEN   dsFPDColor_Make(0, 0xFF, 0)

Green color LED.

Definition at line 766 of file dsTypes.h.

◆ dsFPD_COLOR_RED

#define dsFPD_COLOR_RED   dsFPDColor_Make(0xFF, 0, 0x0)

Red color LED.

Definition at line 767 of file dsTypes.h.

◆ dsFPD_COLOR_YELLOW

#define dsFPD_COLOR_YELLOW   dsFPDColor_Make(0xFF, 0xFF, 0xE0)

Yellow color LED.

Definition at line 768 of file dsTypes.h.

◆ dsFPD_COLOR_ORANGE

#define dsFPD_COLOR_ORANGE   dsFPDColor_Make(0xFF, 0x8C, 0x00)

Orange color LED.

Definition at line 769 of file dsTypes.h.

◆ dsFPD_COLOR_WHITE

#define dsFPD_COLOR_WHITE   dsFPDColor_Make(0xFF, 0xFF, 0xFF)

White color LED.

Definition at line 770 of file dsTypes.h.

◆ dsFPD_COLOR_MAX

#define dsFPD_COLOR_MAX   6

Maximum idx of predefined colors.

Definition at line 771 of file dsTypes.h.

◆ dsFPDColor_isValid

#define dsFPDColor_isValid (   t)    (((t) & 0xFF000000) == 0)

Front panel LED colors validation check.

Definition at line 776 of file dsTypes.h.

◆ dsFPD_INDICATOR_MESSAGE

#define dsFPD_INDICATOR_MESSAGE   0

This enumeration pre-defines common front panel indicators. Implementation may not have to use these enumerators. Message/Mail LED.

Definition at line 789 of file dsTypes.h.

◆ dsFPD_INDICATOR_POWER

#define dsFPD_INDICATOR_POWER   1

Power LED.

Definition at line 790 of file dsTypes.h.

◆ dsFPD_INDICATOR_RECORD

#define dsFPD_INDICATOR_RECORD   2

Record LED.

Definition at line 791 of file dsTypes.h.

◆ dsFPD_INDICATOR_REMOTE

#define dsFPD_INDICATOR_REMOTE   3

Remote LED.

Definition at line 792 of file dsTypes.h.

◆ dsFPD_INDICATOR_RFBYPASS

#define dsFPD_INDICATOR_RFBYPASS   4

RF Bypass LED.

Definition at line 793 of file dsTypes.h.

◆ dsFPDIndicator_isValid

#define dsFPDIndicator_isValid (   t)    (true)

Front panel LED indicator type validation check.

Definition at line 798 of file dsTypes.h.

◆ dsFPDTextDisplay_isValid

#define dsFPDTextDisplay_isValid (   t)    (((t) >= dsFPD_TEXTDISP_TEXT ) && ((t) < dsFPD_TEXTDISP_MAX))

FPD text display type validation check.

Definition at line 812 of file dsTypes.h.

◆ dsFPD_BRIGHTNESS_MAX

#define dsFPD_BRIGHTNESS_MAX   100

Maximum Value of FPD Led Brightness Maximum Value of FPD LED brightness.

Definition at line 856 of file dsTypes.h.

Typedef Documentation

◆ dsFPDTextDisplay_t

typedef enum __dsFPDTextDisplay_t dsFPDTextDisplay_t

This enumeration defines the FPD text display types.

◆ dsFPDState_t

typedef enum __dsFPDState_t dsFPDState_t

This enumeration defines the front panel display state.

◆ dsFPDLedState_t

typedef enum __dsFPDLedState_t dsFPDLedState_t

This enumeration defines the front panel display state.

◆ dsFPDTimeFormat_t

typedef enum __dsFPDTimeFormat_t dsFPDTimeFormat_t

This enumeration defines the time formats to be used in the Front panel text display

◆ dsFPDBrightness_t

typedef uint32_t dsFPDBrightness_t

Type definition for the brightness setting of a front panel indicator LED.

Definition at line 862 of file dsTypes.h.

◆ dsFPDMode_t

typedef enum __dsFPDMode_t dsFPDMode_t

This enumeration defines the front panel display mode.

Enumeration Type Documentation

◆ __dsFPDTextDisplay_t

enum __dsFPDTextDisplay_t

This enumeration defines the FPD text display types.

Enumerator
dsFPD_TEXTDISP_TEXT 

7-segment LED display.

dsFPD_TEXTDISP_MAX 

Maximum index for FPD text display types.

Definition at line 803 of file dsTypes.h.

◆ __dsFPDState_t

enum __dsFPDState_t

This enumeration defines the front panel display state.

Enumerator
dsFPD_STATE_OFF 

FPD State Disable.

dsFPD_STATE_ON 

FPD State Enable.

Definition at line 818 of file dsTypes.h.

◆ __dsFPDLedState_t

enum __dsFPDLedState_t

This enumeration defines the front panel display state.

Definition at line 827 of file dsTypes.h.

◆ __dsFPDTimeFormat_t

enum __dsFPDTimeFormat_t

This enumeration defines the time formats to be used in the Front panel text display

Enumerator
dsFPD_TIME_12_HOUR 

12 hour time format.

dsFPD_TIME_24_HOUR 

24 hour time format.

dsFPD_TIME_STRING 

Text string.

Definition at line 845 of file dsTypes.h.

◆ __dsFPDMode_t

enum __dsFPDMode_t

This enumeration defines the front panel display mode.

Enumerator
dsFPD_MODE_ANY 

All modes (text/clock) are supported

dsFPD_MODE_TEXT 

only Text mode is supported

dsFPD_MODE_CLOCK 

only clock mode is supported

Definition at line 867 of file dsTypes.h.