panel.h

Go to the documentation of this file.

/*
 *  Copyright (C) 2024 Texas Instruments Incorporated
 *
 *  Redistribution and use in source and binary forms, with or without
 *  modification, are permitted provided that the following conditions
 *  are met:
 *
 *    Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 *    Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the
 *    distribution.
 *
 *    Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
 
#ifndef PANEL_H_
#define PANEL_H_
 
/* ========================================================================== */
/*                             Include Files                                  */
/* ========================================================================== */
 
#include <stdint.h>
#include <kernel/dpl/SystemP.h>
#include <drivers/hw_include/soc_config.h>
#include <kernel/dpl/SemaphoreP.h>
#include <board/ioexp/ioexp_tca6424.h>
 
#ifdef __cplusplus
extern "C"
{
#endif
 
/* ========================================================================== */
/*                           Macros & Typedefs                                */
/* ========================================================================== */
 
#define PANEL_INVALID_VALUE (0xFFFFFFFFU)
 
#define CONFIG_PANEL_TYPE_I2C                       (0x00U)
#define CONFIG_PANEL_TYPE_DSI                       (0x01U)
#define CONFIG_PANEL_TYPE_INVALID                   (0xFFU)
 
#define PANEL_MAX_NUM_PINS_CTRL                     (0xAU)
 
typedef void  *Panel_Handle;
 
typedef struct Panel_Config_s Panel_Config;
 
typedef struct Panel_Params_s Panel_Params;
 
typedef int32_t (*Panel_OpenFxn)(Panel_Config *config, Panel_Params *params);
 
typedef void (*Panel_CloseFxn)(Panel_Config *config, Panel_Params *params);
 
typedef int32_t (*Panel_ControlFxn)(Panel_Config *config, Panel_Params *params,
                                    uint32_t cmd, void *cmdArgs);
 
typedef int32_t (*Panel_ResetFxn)(Panel_Config *config, Panel_Params *params);
 
/* ========================================================================== */
/*                         Structure Declarations                             */
/* ========================================================================== */
 
typedef struct
{
    uint32_t deviceI2cInstId;
    uint32_t deviceI2cAddr;
    uint32_t inpClk;
    uint32_t hotPlugGpioIntrLine;
    uint32_t clkEdge;
    uint32_t outputFormat;
} Panel_BridgeParams;
 
typedef struct
{
    uint32_t standard;
    uint32_t videoIfMode;
    uint32_t videoIfWidth;
    uint32_t videoDataFormat;
} Panel_vidOutputParams;
 
typedef struct
{
    uint32_t pinIoNum;
    uint32_t pinType;
    uint32_t pinVal;
} Panel_PinConfig;
 
typedef struct
{
    uint32_t pinCtrlI2cInstance;
    uint32_t pinCtrlI2cAddr;
    uint32_t numPins;
    Panel_PinConfig pinConf[PANEL_MAX_NUM_PINS_CTRL];
    TCA6424_Config ioExpConfig;
} Panel_PinCtrl;
 
typedef struct Panel_Params_s
{
    Panel_BridgeParams      bridgeParams;
    Panel_vidOutputParams   vidOutParams;
} Panel_Params;
 
typedef struct
{
    Panel_OpenFxn       openFxn;
    Panel_CloseFxn      closeFxn;
    Panel_ControlFxn    controlFxn;
    Panel_ResetFxn      resetFxn;
} Panel_Fxns;
 
typedef struct Panel_Config_s
{
    uint32_t                   panelType;
    Panel_Fxns                 *fxns;
    void                       *object;
    void                       *inputParams;
    Panel_PinCtrl              *pinConfig;
    SemaphoreP_Object          lockSem;
} Panel_Config;
 
/* ========================================================================== */
/*                          Function Declarations                             */
/* ========================================================================== */
 
Panel_Handle Panel_open(uint32_t instanceId, Panel_Params *params);
 
void Panel_close(Panel_Handle handle);
 
Panel_Handle Panel_getHandle(uint32_t instanceId);
 
int32_t Panel_control(Panel_Handle handle, uint32_t cmd, void *cmdArgs);
 
int32_t Panel_reset(Panel_Handle handle);
 
uint32_t Panel_getPanelInterfaceIndex(uint32_t panelType);
 
void Panel_init(void);
 
void Panel_deinit(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* PANEL_H_ */