Introduction

This module contains APIs to program and use the Panel module on the board like HDMI Panel connected over a bridge. See PANEL for more details.

Data Structures
struct	Panel_BridgeParams
	Bridge configuration parameters. More...

struct	Panel_vidOutputParams
	Configuration paramters for bridge encoder. More...

struct	Panel_PinConfig
	Panel pin control data. More...

struct	Panel_PinCtrl
	Configuration paramters for panel pin control. More...

struct	Panel_Params
	Parameters passed during Panel_open() More...

struct	Panel_Fxns
	Driver implementation callbacks. More...

struct	Panel_Config
	Panel driver configuration, these are filled by SysCfg based on the panel device that is selected. More...

Functions
Panel_Handle	Panel_open (uint32_t instanceId, Panel_Params *params)
	Open panel driver. More...

void	Panel_close (Panel_Handle handle)
	Close panel driver. More...

Panel_Handle	Panel_getHandle (uint32_t instanceId)
	Get handle to panel driver. More...

int32_t	Panel_control (Panel_Handle handle, uint32_t cmd, void *cmdArgs)
	Control Panel operation using panel specific commands. More...

int32_t	Panel_reset (Panel_Handle handle)
	Do a reset of the panel. More...

uint32_t	Panel_getPanelInterfaceIndex (uint32_t panelType)
	Return panel index based on type of panel. More...

void	Panel_init (void)
	This function initializes the Panel module. More...

void	Panel_deinit (void)
	This function de-initializes the Panel module. More...

Typedefs
typedef void *	Panel_Handle
	Handle to the FLash driver returned by Panel_open() More...

typedef struct Panel_Config_s	Panel_Config
	Forward declaration of Panel_Config. More...

typedef struct Panel_Params_s	Panel_Params
	Forward declaration of Panel_Params. More...

Macros
#define	PANEL_INVALID_VALUE (0xFFFFFFFFU)

#define	PANEL_MAX_NUM_PINS_CTRL (0xAU)
	Max number pins configured for panel pin control. More...

#define	CONFIG_PANEL_TYPE_I2C (0x00U)
	Panel type supported. More...

#define	CONFIG_PANEL_TYPE_DSI (0x01U)

#define	CONFIG_PANEL_TYPE_INVALID (0xFFU)

Panel driver implementation callbacks
typedef int32_t(*	Panel_OpenFxn) (Panel_Config config, Panel_Params params)
	Driver implementation to open a specific panel driver. More...

typedef void(*	Panel_CloseFxn) (Panel_Config config, Panel_Params params)
	Driver implementation to close a specific panel driver. More...

typedef int32_t(*	Panel_ControlFxn) (Panel_Config config, Panel_Params params, uint32_t cmd, void *cmdArgs)
	Driver implementation to control panel using a specific panel driver. More...

typedef int32_t(*	Panel_ResetFxn) (Panel_Config config, Panel_Params params)
	Driver implementation to soft reset the panel. More...

Macro Definition Documentation

◆ PANEL_INVALID_VALUE

#define PANEL_INVALID_VALUE (0xFFFFFFFFU)

◆ CONFIG_PANEL_TYPE_I2C

#define CONFIG_PANEL_TYPE_I2C (0x00U)

Panel type supported.

◆ CONFIG_PANEL_TYPE_DSI

#define CONFIG_PANEL_TYPE_DSI (0x01U)

◆ CONFIG_PANEL_TYPE_INVALID

#define CONFIG_PANEL_TYPE_INVALID (0xFFU)

◆ PANEL_MAX_NUM_PINS_CTRL

#define PANEL_MAX_NUM_PINS_CTRL (0xAU)

Max number pins configured for panel pin control.

Typedef Documentation

◆ Panel_Handle

typedef void* Panel_Handle

Handle to the FLash driver returned by Panel_open()

◆ Panel_Config

typedef struct Panel_Config_s Panel_Config

Forward declaration of Panel_Config.

◆ Panel_Params

typedef struct Panel_Params_s Panel_Params

Forward declaration of Panel_Params.

◆ Panel_OpenFxn

typedef int32_t(* Panel_OpenFxn) (Panel_Config *config, Panel_Params *params)

Driver implementation to open a specific panel driver.

Typically this callback is hidden from the end application and is implemented when a new type of panel device needs to be implemented.

Parameters

config	[in] Panel configuration for the specific panel device
params	[in] User controllable parameters when opening the panel device

Returns: SystemP_SUCCESS on success, else failure

◆ Panel_CloseFxn

typedef void(* Panel_CloseFxn) (Panel_Config *config, Panel_Params *params)

Driver implementation to close a specific panel driver.

Typically this callback is hidden from the end application and is implemented when a new type of panel device needs to be implemented.

Parameters

config	[in] Panel configuration for the specific panel device.
params	[in] User controllable parameters when opening the panel device.

Returns: SystemP_SUCCESS on success, else failure.

◆ Panel_ControlFxn

typedef int32_t(* Panel_ControlFxn) (Panel_Config *config, Panel_Params *params, uint32_t cmd, void *cmdArgs)

Driver implementation to control panel using a specific panel driver.

Typically this callback is hidden from the end application and is implemented when a new type of panel device needs to be implemented.

Parameters

config	[in] Panel configuration for the specific panel device.
params	[in] User controllable parameters.
cmd	[in] Specific command to panel control.
cmdArgs	[in] Pointer to arguments associated with command.

Returns: SystemP_SUCCESS on success, else failure

◆ Panel_ResetFxn

typedef int32_t(* Panel_ResetFxn) (Panel_Config *config, Panel_Params *params)

Driver implementation to soft reset the panel.

Typically this callback is hidden from the end application and is implemented when a new type of panel device needs to be implemented.

Parameters

config	[in] Panel configuration for the specific panel device.
params	[in] User controllable parameters when opening the panel device.

Returns: SystemP_SUCCESS on success, else failure.

Function Documentation

◆ Panel_open()

Panel_Handle Panel_open	(	uint32_t	instanceId,
		Panel_Params *	params
	)

Open panel driver.

Global variables Panel_Config gPanelConfig[] and uint32_t gPanelConfigNum is instantiated by SysCfg to describe the panel configuration based on user selection in SysCfg.

Parameters

instanceId	[in] Index within `Panel_Config gPanelConfig[]` denoting the panel driver to open.
params	[in] Open parameters.

Returns: Handle to panel driver which should be used in subsequent API call.; NULL in case of failure.

◆ Panel_close()

void Panel_close ( Panel_Handle handle )

Close panel driver.

Parameters

handle [in] Panel driver handle from Panel_open.

◆ Panel_getHandle()

Panel_Handle Panel_getHandle ( uint32_t instanceId )

Get handle to panel driver.

Parameters

instanceId [in] Index within Panel_Config gPanelConfig[].

Returns: Handle to panel driver.; NULL in case of failure.

◆ Panel_control()

int32_t Panel_control	(	Panel_Handle	handle,
		uint32_t	cmd,
		void *	cmdArgs
	)

Control Panel operation using panel specific commands.

Commands can be refered from specific panel interface layer.

Parameters

handle	[in] Panel driver handle from Panel_open.
cmd	[in] Input command to control panel.
cmdArgs	[in] Pointer to command arguments.

Returns: SystemP_SUCCESS on success, else failure.

◆ Panel_reset()

int32_t Panel_reset ( Panel_Handle handle )

Do a reset of the panel.

Parameters

handle [in] Panel driver handle from Panel_open.

Returns: SystemP_SUCCESS on success, else failure.

◆ Panel_getPanelInterfaceIndex()

uint32_t Panel_getPanelInterfaceIndex ( uint32_t panelType )

Return panel index based on type of panel.

Parameters

panelType [in] Panel type.

Returns: Panel driver instance index corresponding to the panel type.

◆ Panel_init()

void Panel_init ( void )

This function initializes the Panel module.

◆ Panel_deinit()

void Panel_deinit ( void )

This function de-initializes the Panel module.

Introduction

Data Structures

Functions

Typedefs

Macros

Panel driver implementation callbacks

Macro Definition Documentation

◆ PANEL_INVALID_VALUE

◆ CONFIG_PANEL_TYPE_I2C

◆ CONFIG_PANEL_TYPE_DSI

◆ CONFIG_PANEL_TYPE_INVALID

◆ PANEL_MAX_NUM_PINS_CTRL

Typedef Documentation

◆ Panel_Handle

◆ Panel_Config

◆ Panel_Params

◆ Panel_OpenFxn

◆ Panel_CloseFxn

◆ Panel_ControlFxn

◆ Panel_ResetFxn

Function Documentation

◆ Panel_open()

◆ Panel_close()

◆ Panel_getHandle()

◆ Panel_control()

◆ Panel_reset()

◆ Panel_getPanelInterfaceIndex()

◆ Panel_init()

◆ Panel_deinit()