Description

Functions
dsError_t	dsFPInit (void)
	This function is used to initialize the underlying front panel display sub-system. More...

dsError_t	dsSetFPBlink (dsFPDIndicator_t eIndicator, unsigned int uBlinkDuration, unsigned int uBlinkIterations)
	Set LED blinking mode. More...

dsError_t	dsSetFPBrightness (dsFPDIndicator_t eIndicator, dsFPDBrightness_t eBrightness)
	Set LED brightness level. More...

dsError_t	dsGetFPState (dsFPDIndicator_t eIndicator, dsFPDState_t *state)
	This function will Get the ON or OFF state of Specified LEDs. More...

dsError_t	dsSetFPState (dsFPDIndicator_t eIndicator, dsFPDState_t state)
	This function will enable or disable the specified discrete LED on the front panel display. More...

dsError_t	dsGetFPBrightness (dsFPDIndicator_t eIndicator, dsFPDBrightness_t *pBrightness)
	Get the brightness level for Front Panel Display LEDs. More...

dsError_t	dsGetFPColor (dsFPDIndicator_t eIndicator, dsFPDColor_t *pColor)
	Get LED color. More...

dsError_t	dsSetFPColor (dsFPDIndicator_t eIndicator, dsFPDColor_t eColor)
	Set LED color. More...

dsError_t	dsSetFPTime (dsFPDTimeFormat_t eTimeFormat, const unsigned int uHour, const unsigned int uMinutes)
	Set time on 7-Segment Display. More...

dsError_t	dsSetFPText (const char *pText)
	Set text on 7-Segment Display. More...

dsError_t	dsSetFPTextBrightness (dsFPDTextDisplay_t eIndicator, dsFPDBrightness_t eBrightness)
	Set brightness level of 7-Segment Display. More...

dsError_t	dsGetFPTextBrightness (dsFPDTextDisplay_t eIndicator, dsFPDBrightness_t *eBrightness)
	Get the brightness of 7-Segment Display LEDs. More...

dsError_t	dsFPEnableCLockDisplay (int enable)
	Use disable and enable display of clock. More...

dsError_t	dsSetFPScroll (unsigned int uScrollHoldOnDur, unsigned int uHorzScrollIterations, unsigned int uVertScrollIterations)
	Scroll text on 7-Segment Display. More...

dsError_t	dsFPTerm (void)
	Terminate the the Front Panel Display sub-system. More...

dsError_t	dsSetFPDBrightness (dsFPDIndicator_t eIndicator, dsFPDBrightness_t eBrightness, bool toPersist)
	This function will set the brightness of the specified discrete LED on the front panel display to the specified brightness level in multi-app mode using iarmbus call. The brightness level shall be persisted if the input parameter toPersist passed is TRUE. More...

dsError_t	dsSetFPDColor (dsFPDIndicator_t eIndicator, dsFPDColor_t eColor, bool toPersist)
	This function sets the color of the specified LED on the front panel in multi-app mode using iarmbus call. The color of the LED shall be persisted if the input parameter toPersist is set to TRUE. More...

dsError_t	dsSetFPTimeFormat (dsFPDTimeFormat_t eTimeFormat)
	This function sets the 7-segment display LEDs to show the specified time in specified format. More...

dsError_t	dsGetFPTimeFormat (dsFPDTimeFormat_t *pTimeFormat)
	This function get the Current time zone format set on 7-segment display LEDs panel. More...

dsError_t	dsSetFPDMode (dsFPDMode_t eMode)
	This function sets the display mode of the FPD text display. More...

dsError_t	dsFPGetSupportedLEDStates (unsigned int *states)
	This function returns the supported led states. More...

dsError_t	dsFPGetLEDState (dsFPDLedState_t *state)
	This function returns the current led state. More...

dsError_t	dsFPSetLEDState (dsFPDLedState_t state)
	This function sets the led state. More...

Function Documentation

◆ dsFPInit()

dsError_t dsFPInit ( void )

This function is used to initialize the underlying front panel display sub-system.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsFPInit API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 42 of file dsFPD.c.

◆ dsSetFPBlink()

dsError_t dsSetFPBlink	(	dsFPDIndicator_t	eIndicator,
		unsigned int	uBlinkDuration,
		unsigned int	uBlinkIterations
	)

Set LED blinking mode.

This function is used to set the individual discrete LEDs to blink for a specified number of times at the specified blink interval.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED, etc.).
[in]	uBlinkDuration	Blink interval. The percentage of time the text display will remain on during one blink iteration.
[in]	uBlinkIterations	Number of times for the given LED to blink. The number of times per minute data will blink across all of the LEDs.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPBlink API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 161 of file dsFPD.c.

◆ dsSetFPBrightness()

dsError_t dsSetFPBrightness	(	dsFPDIndicator_t	eIndicator,
		dsFPDBrightness_t	eBrightness
	)

Set LED brightness level.

This function will set the brightness of the specified discrete LEDs on the Front Panel Display to the specified brightness level. The Power LED brightness setting will also be adjusted to this setting.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED, and so on).
[in]	eBrightness	The brightness value for the specified indicator.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPBrightness API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 213 of file dsFPD.c.

◆ dsGetFPState()

dsError_t dsGetFPState	(	dsFPDIndicator_t	eIndicator,
		dsFPDState_t *	state
	)

This function will Get the ON or OFF state of Specified LEDs.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED and so on).
[out]	state	Pointer to hold the state of the specified indicator.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsGetFPState API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 480 of file dsFPD.c.

◆ dsSetFPState()

dsError_t dsSetFPState	(	dsFPDIndicator_t	eIndicator,
		dsFPDState_t	state
	)

This function will enable or disable the specified discrete LED on the front panel display.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED and so on).
[in]	state	Indicates ON or OFF state for the indicator.(ON = 1 and OFF = 0).

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPState API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 410 of file dsFPD.c.

◆ dsGetFPBrightness()

dsError_t dsGetFPBrightness	(	dsFPDIndicator_t	eIndicator,
		dsFPDBrightness_t *	pBrightness
	)

Get the brightness level for Front Panel Display LEDs.

This function returns the brightness level of the specified discrete LEDs on the front panel.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED, etc.).
[out]	*pBrightness	The address of a location to hold the brightness value for the specified indicator on return.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsGetFPBrightness API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 187 of file dsFPD.c.

◆ dsGetFPColor()

dsError_t dsGetFPColor	(	dsFPDIndicator_t	eIndicator,
		dsFPDColor_t *	pColor
	)

Get LED color.

This function Gets the color of the specified front panel indicator LED, if the indicator supports it (i.e. is multi-colored). It must return dsERR_OPERATION_NOT_SUPPORTED if the indicator is single-colored.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED, etc.).
[in]	*pColor	The address of a location to hold the color value

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsGetFPColor API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 317 of file dsFPD.c.

◆ dsSetFPColor()

dsError_t dsSetFPColor	(	dsFPDIndicator_t	eIndicator,
		dsFPDColor_t	eColor
	)

Set LED color.

This function sets the color of the specified front panel indicator LED, if the indicator supports it (i.e. is multi-colored). It must return dsERR_OPERATION_NOT_SUPPORTED if the indicator is single-colored.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED, etc.).
[in]	eColor	The color index for the specified indicator.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPColor API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 343 of file dsFPD.c.

◆ dsSetFPTime()

dsError_t dsSetFPTime	(	dsFPDTimeFormat_t	eTimeFormat,
		const unsigned int	uHour,
		const unsigned int	uMinutes
	)

Set time on 7-Segment Display.

This function sets the 7-segment display LEDs to show the time. The format (12/24-hour) must be specified. If there are no 7-Segment display LEDs present on the device then dsERR_OPERATION_NOT_SUPPORTED must be returned. The function shall return dsERR_INVALID_PARAM if the format and hours values do not agree, or if the hours/minutes are invalid.

Parameters

[in]	eTimeFormat	Time format (12 or 24 hrs).
[in]	uHour	Hour information.
[in]	uMinutes	Minutes information.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPTime API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 110 of file dsFPD.c.

◆ dsSetFPText()

dsError_t dsSetFPText ( const char * pText )

Set text on 7-Segment Display.

This function is used to set the 7-segment display LEDs to show the given text. The supported format of text is specified. If there are no 7-Segment display LEDs present on the device then dsERR_OPERATION_NOT_SUPPORTED must be returned.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPText API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 80 of file dsFPD.c.

◆ dsSetFPTextBrightness()

dsError_t dsSetFPTextBrightness	(	dsFPDTextDisplay_t	eIndicator,
		dsFPDBrightness_t	eBrightness
	)

Set brightness level of 7-Segment Display.

This function will set the brightness of the specified 7-Segment Display LEDs on the Front Panel Display to the specified brightness level.

Parameters

[in]	eIndicator	FPD Indicator index (Clock LED).
[in]	eBrightness	The brightness value for the specified indicator.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPTextBrightness API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 295 of file dsFPD.c.

◆ dsGetFPTextBrightness()

dsError_t dsGetFPTextBrightness	(	dsFPDTextDisplay_t	eIndicator,
		dsFPDBrightness_t *	eBrightness
	)

Get the brightness of 7-Segment Display LEDs.

This function will Get the brightness of the specified 7-Segment Display LEDs on the Front Panel Text Display .

Parameters

[in]	eIndicator	FPD Indicator index (CLock Led.).
[in]	eBrightness	The address of a location to hold the brightness value for the specified indicator on return.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsGetFPTextBrightness API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 270 of file dsFPD.c.

◆ dsFPEnableCLockDisplay()

dsError_t dsFPEnableCLockDisplay ( int enable )

Use disable and enable display of clock.

This function will enable or disable displaying of clock.

Parameters

[in] enable Indicates the clock to be enabled or disabled. (TRUE = enable clock and FALSE = disable clock).

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsFPEnableCLockDisplay API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 390 of file dsFPD.c.

◆ dsSetFPScroll()

dsError_t dsSetFPScroll	(	unsigned int	uScrollHoldOnDur,
		unsigned int	uHorzScrollIterations,
		unsigned int	uVertScrollIterations
	)

Scroll text on 7-Segment Display.

This function scrolls the text in the 7-segment LEDs for the given number of iterations.

Parameters

[in]	uScrollHoldOnDur	Duration for the scroll to hold each character before scrolling it to the next position during one scroll iteration.
[in]	uHorzScrollIterations	Number of iterations for which to scroll horizontally.
[in]	uVertScrollIterations	Number of iterations for which to scroll vertically.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPScroll API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 135 of file dsFPD.c.

◆ dsFPTerm()

dsError_t dsFPTerm ( void )

Terminate the the Front Panel Display sub-system.

This function resets any data structures used within the platform front-panel module, and releases the front-panel specific device handles.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsFPTerm API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 62 of file dsFPD.c.

◆ dsSetFPDBrightness()

dsError_t dsSetFPDBrightness	(	dsFPDIndicator_t	eIndicator,
		dsFPDBrightness_t	eBrightness,
		bool	toPersist
	)

This function will set the brightness of the specified discrete LED on the front panel display to the specified brightness level in multi-app mode using iarmbus call. The brightness level shall be persisted if the input parameter toPersist passed is TRUE.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED, and so on).
[in]	eBrightness	The brightness value for the specified indicator.
[in]	toPersist	If set to TRUE, the brightness value shall be persisted.

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPBrightness API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 242 of file dsFPD.c.

◆ dsSetFPDColor()

dsError_t dsSetFPDColor	(	dsFPDIndicator_t	eIndicator,
		dsFPDColor_t	eColor,
		bool	toPersist
	)

This function sets the color of the specified LED on the front panel in multi-app mode using iarmbus call. The color of the LED shall be persisted if the input parameter toPersist is set to TRUE.

Parameters

[in]	eIndicator	FPD Indicator index (Power LED, Record LED and so on).
[in]	eColor	Indicates the RGB color to be set for the specified LED.
[in]	toPersist	Indicates whether to persist the specified LED color or not. (If TRUE persists the LED color else doesn't persist it)

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPColor API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 367 of file dsFPD.c.

◆ dsSetFPTimeFormat()

dsError_t dsSetFPTimeFormat ( dsFPDTimeFormat_t eTimeFormat )

This function sets the 7-segment display LEDs to show the specified time in specified format.

Parameters

[in] eTimeFormat Indicates the time format (12 hour or 24 hour).

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPTime API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 458 of file dsFPD.c.

◆ dsGetFPTimeFormat()

dsError_t dsGetFPTimeFormat ( dsFPDTimeFormat_t * pTimeFormat )

This function get the Current time zone format set on 7-segment display LEDs panel.

Parameters

[in]	None.
[out]	pTimeFormat	Pointer to hold the Current time format value .

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsGetFPBrightness API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 435 of file dsFPD.c.

◆ dsSetFPDMode()

dsError_t dsSetFPDMode ( dsFPDMode_t eMode )

This function sets the display mode of the FPD text display.

Parameters

[in] eMode Indicates the mode (any, clock or text)

Returns: Device Settings error code

Return values

dsERR_NONE	Indicates dsSetFPDMode API was successfully called using iarmbus call.
dsERR_GENERAL	Indicates error due to general failure.

Definition at line 504 of file dsFPD.c.

◆ dsFPGetSupportedLEDStates()

dsError_t dsFPGetSupportedLEDStates ( unsigned int * states )

This function returns the supported led states.

Parameters

[out] return the bitwise value of all supported led states by the platform

Returns: front panel error code

Return values

dsERR_NONE	Indicates api was successful
dsERR_GENERAL	Indicates error due to general failure.

◆ dsFPGetLEDState()

dsError_t dsFPGetLEDState ( dsFPDLedState_t * state )

This function returns the current led state.

Parameters

[out] returns current led state

Returns: front panel error code

Return values

dsERR_NONE	Indicates api was successful
dsERR_GENERAL	Indicates error due to general failure.

◆ dsFPSetLEDState()

dsError_t dsFPSetLEDState ( dsFPDLedState_t state )

This function sets the led state.

Parameters

[in] let state to set

Returns: front panel error code

Return values

dsERR_NONE	Indicates api was successful
dsERR_GENERAL	Indicates error due to general failure.

Description

Functions

Function Documentation

◆ dsFPInit()

◆ dsSetFPBlink()

◆ dsSetFPBrightness()

◆ dsGetFPState()

◆ dsSetFPState()

◆ dsGetFPBrightness()

◆ dsGetFPColor()

◆ dsSetFPColor()

◆ dsSetFPTime()

◆ dsSetFPText()

◆ dsSetFPTextBrightness()

◆ dsGetFPTextBrightness()

◆ dsFPEnableCLockDisplay()

◆ dsSetFPScroll()

◆ dsFPTerm()

◆ dsSetFPDBrightness()

◆ dsSetFPDColor()

◆ dsSetFPTimeFormat()

◆ dsGetFPTimeFormat()

◆ dsSetFPDMode()

◆ dsFPGetSupportedLEDStates()

◆ dsFPGetLEDState()

◆ dsFPSetLEDState()