dpredriver.h

00001 /**
00002   ******************************************************************************
00003   * @file    dpredriver.h
00004   * @author  MCD Application Team
00005   * @brief   This header file contains the functions prototypes for the  
00006   *          DisplayPort Linear Redriver.
00007   ******************************************************************************
00008   * @attention
00009   *
00010   * <h2><center>&copy; Copyright (c) 2017 STMicroelectronics.
00011   * All rights reserved.</center></h2>
00012   *
00013   * This software component is licensed by ST under BSD 3-Clause license,
00014   * the "License"; You may not use this file except in compliance with the
00015   * License. You may obtain a copy of the License at:
00016   *                        opensource.org/licenses/BSD-3-Clause
00017   *
00018   ******************************************************************************
00019   */
00020 
00021 /* Define to prevent recursive inclusion -------------------------------------*/
00022 #ifndef __DPREDRIVER_H
00023 #define __DPREDRIVER_H
00024 
00025 #ifdef __cplusplus
00026  extern "C" {
00027 #endif
00028 
00029 /* Includes ------------------------------------------------------------------*/
00030 #include <stdint.h>
00031 
00032 /** @addtogroup BSP
00033   * @{
00034   */
00035 
00036 /** @addtogroup Components
00037   * @{
00038   */
00039     
00040 /** @addtogroup DPREDRIVER
00041   * @{
00042   */
00043 
00044 /** @defgroup DPREDRIVER_Exported_Types
00045   * @{
00046   */ 
00047 
00048 /** @defgroup DPREDRIVER_Channel_Identifier  Channel Identifier
00049   * @{
00050   */
00051  typedef enum {
00052    CHANNEL_DP0 = 0,
00053    CHANNEL_DP1,
00054    CHANNEL_DP2,
00055    CHANNEL_DP3,
00056    CHANNEL_RX1,
00057    CHANNEL_RX2,
00058    CHANNEL_SSTX
00059  } DPREDRIVER_ChannelId_t;
00060 /**
00061   * @}
00062   */
00063   
00064  /** @defgroup DPREDRIVER_Driver_structure  DisplayPort Linear Redriver Driver structure
00065   * @{
00066   */
00067 typedef struct
00068 {
00069   uint32_t  (*Init)(uint16_t);
00070   void      (*DeInit)(uint16_t); 
00071   uint32_t  (*PowerOn)(uint16_t);
00072   uint32_t  (*PowerOff)(uint16_t);
00073   uint32_t  (*SetEQGain)(uint16_t, DPREDRIVER_ChannelId_t, uint8_t);
00074   uint32_t  (*EnableChannel)(uint16_t, DPREDRIVER_ChannelId_t);
00075   uint32_t  (*DisableChannel)(uint16_t, DPREDRIVER_ChannelId_t);
00076 }DPREDRIVER_Drv_t;
00077 /**
00078   * @}
00079   */
00080 
00081 /**
00082   * @}
00083   */
00084 
00085 
00086 /**
00087   * @}
00088   */
00089 
00090 /**
00091   * @}
00092   */
00093 
00094 /**
00095   * @}
00096   */
00097 
00098 #ifdef __cplusplus
00099 }
00100 #endif
00101 
00102 #endif /* __DPREDRIVER_H */
00103 
00104 /************************ (C) COPYRIGHT STMicroelectronics *****END OF FILE****/