cosmetics of all modules (add file header and sections)

leonardocavagnis · facchinm · commit 1e44e290beae · 2023-04-19T13:45:00.000+02:00
diff --git a/libraries/H7_Video/examples/ArduinoLogo/ArduinoLogo.ino b/libraries/H7_Video/examples/ArduinoLogo/ArduinoLogo.ino
@@ -18,6 +18,7 @@ INCBIN(test, "/home/user/Downloads/test.bin");
 */
 
 H7_Video Display(480, 800, GIGA_DISPLAY_SHIELD);
+//H7_Video Display(720, 480);
 
 void setup() {
   Display.begin();
diff --git a/libraries/H7_Video/examples/ArduinoLogoDrawing/ArduinoLogoDrawing.ino b/libraries/H7_Video/examples/ArduinoLogoDrawing/ArduinoLogoDrawing.ino
@@ -9,6 +9,7 @@
 #include "H7_Video.h" // H7_Video depends on ArduinoGraphics
 
 H7_Video Display(480, 800, GIGA_DISPLAY_SHIELD);
+//H7_Video Display(720, 480);
 
 void setup() {
   Display.begin();
diff --git a/libraries/H7_Video/examples/LVGLDemo/LVGLDemo.ino b/libraries/H7_Video/examples/LVGLDemo/LVGLDemo.ino
@@ -3,6 +3,7 @@
 #include "giga_touch.h"
 
 H7_Video Display(480, 800, GIGA_DISPLAY_SHIELD);
+//H7_Video Display(720, 480);
 
 //@TODO: Complete demo with 4 main features
 
diff --git a/libraries/H7_Video/src/H7_Video.cpp b/libraries/H7_Video/src/H7_Video.cpp
@@ -1,3 +1,14 @@
+/**
+  ******************************************************************************
+  * @file    H7_Video.cpp
+  * @author  
+  * @version 
+  * @date    
+  * @brief
+  ******************************************************************************
+  */
+
+ /* Includes ------------------------------------------------------------------*/
 #include "H7_Video.h"
 
 #include "dsi.h"
@@ -8,10 +19,14 @@
 
 #if __has_include ("lvgl.h")
 #include "lvgl.h"
+#endif
 
+/* Private function prototypes -----------------------------------------------*/
+#if __has_include ("lvgl.h")
 void lvgl_displayFlushing(lv_disp_drv_t * disp, const lv_area_t * area, lv_color_t * color_p);
 #endif
 
+/* Functions -----------------------------------------------------------------*/
 H7_Video::H7_Video(int width, int heigth, DisplayShieldModel shield) :
   ArduinoGraphics(width, heigth) {
     _shield = shield;
@@ -162,4 +177,6 @@ void H7_Video::attachLVGLTouchCb(void (*touch_cb)(void*,void*)) {
   indev_drv.read_cb = (void(*)(lv_indev_drv_t *, lv_indev_data_t *))(touch_cb);   /* Set your driver function */
   lv_indev_t * my_indev = lv_indev_drv_register(&indev_drv);                      /* Register the driver in LVGL and save the created input device object */
 }
-#endif
+#endif
+
+/**** END OF FILE ****/
diff --git a/libraries/H7_Video/src/H7_Video.h b/libraries/H7_Video/src/H7_Video.h
@@ -1,16 +1,30 @@
+/**
+  ******************************************************************************
+  * @file    H7_Video.h
+  * @author  
+  * @version 
+  * @date    
+  * @brief   
+  ******************************************************************************
+  */
+
 #ifndef _H7_VIDEO_H
 #define _H7_VIDEO_H
 
+/* Includes ------------------------------------------------------------------*/
 #include <ArduinoGraphics.h>
 
+/* Exported defines ----------------------------------------------------------*/
 #define H7_VIDEO_MAX_WIDTH          1280 
 #define H7_VIDEO_MAX_HEIGHT         1024 
 
+/* Exported enumeration ------------------------------------------------------*/
 enum DisplayShieldModel {
     NONE_SHIELD = 0,
     GIGA_DISPLAY_SHIELD = 1
 };
 
+/* Class ----------------------------------------------------------------------*/
 class H7_Video : public ArduinoGraphics {
 public:
   H7_Video(int width = H7_VIDEO_MAX_WIDTH, int heigth = H7_VIDEO_MAX_HEIGHT, DisplayShieldModel shield = NONE_SHIELD);
diff --git a/libraries/H7_Video/src/anx7625.cpp b/libraries/H7_Video/src/anx7625.cpp
@@ -1,18 +1,25 @@
-/*
- * This file is part of the coreboot project.
- *
- * Copyright 2019 Analogix Semiconductor.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 2 of the License.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
- */
-
+/**
+  ******************************************************************************
+  * @file    anx7625.cpp
+  * @author  
+  * @version 
+  * @date    
+  * @brief 	This file is part of the coreboot project.
+  * 		Copyright 2019 Analogix Semiconductor.
+  *
+  * 		This program is free software; you can redistribute it and/or modify
+  * 		it under the terms of the GNU General Public License as published by
+  * 		the Free Software Foundation; version 2 of the License.
+  *
+  * 		This program is distributed in the hope that it will be useful,
+  * 		but WITHOUT ANY WARRANTY; without even the implied warranty of
+  * 		MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+  * 		GNU General Public License for more details.
+  *
+  ******************************************************************************
+  */
+
+/* Includes ------------------------------------------------------------------*/
 #include <Arduino.h>
 #include <drivers/DigitalOut.h>
 #include <drivers/DigitalInOut.h>
@@ -24,6 +31,7 @@
 #include "anx7625.h"
 #include "video_modes.h"
 
+/* Private define ------------------------------------------------------------*/
 #if 0
 	#define ANXERROR(format, ...) \
 			printk(BIOS_ERR, "ERROR: %s: " format, __func__, ##__VA_ARGS__)
@@ -376,6 +384,7 @@ enum AudioWdLen {
 #define ONE_BLOCK_SIZE      	128
 #define FOUR_BLOCK_SIZE     	(ONE_BLOCK_SIZE*4)
 
+/* Private function prototypes -----------------------------------------------*/
 static mbed::DigitalOut video_on(PK_2, 0);
 static mbed::DigitalOut video_rst(PJ_3, 0);
 static mbed::DigitalInOut otg_on(PJ_6, PIN_INPUT, PullUp, 0);
@@ -412,6 +421,8 @@ static void anx7625_start_dp_work(uint8_t bus);
 static int anx7625_hpd_change_detect(uint8_t bus);
 static void anx7625_parse_edid(const struct edid *edid, struct display_timing *dt);
 
+/* Functions -----------------------------------------------------------------*/
+
 int anx7625_dp_start(uint8_t bus, const struct edid *edid, enum edid_modes mode) {
 	int ret;
 	struct display_timing dt;
@@ -1383,4 +1394,6 @@ void anx7625_parse_edid(const struct edid *edid, struct display_timing *dt) {
 		dt->vactive, dt->vsync_len, dt->vfront_porch, dt->vback_porch);
 }
 
-#endif // defined(ARDUINO_PORTENTA_H7_M7)
+#endif // defined(ARDUINO_PORTENTA_H7_M7)
+
+/**** END OF FILE ****/
diff --git a/libraries/H7_Video/src/anx7625.h b/libraries/H7_Video/src/anx7625.h
@@ -1,16 +1,22 @@
-/* SPDX-License-Identifier: GPL-2.0-only */
-/*
- * Copyright(c) 2016, Analogix Semiconductor. All rights reserved.
- *
- */
+/**
+  ******************************************************************************
+  * @file    anx7625.h
+  * @author  
+  * @version 
+  * @date    
+  * @brief 	
+  ******************************************************************************
+  */
 
+#ifndef _ANX7625_H
+#define _ANX7625_H
+
+/* Includes ------------------------------------------------------------------*/
 extern "C" {
 #include <edid.h>
 }
 
-#ifndef _ANX7625_H
-#define _ANX7625_H
-
+/* Exported functions --------------------------------------------------------*/
 int 	anx7625_dp_start(uint8_t bus, const struct edid *edid, enum edid_modes mode = EDID_MODE_AUTO);
 int 	anx7625_dp_get_edid(uint8_t bus, struct edid *out);
 int 	anx7625_init(uint8_t bus);
@@ -19,4 +25,4 @@ int 	anx7625_get_cc_status(uint8_t bus, uint8_t *cc_status);
 int 	anx7625_read_system_status(uint8_t bus, uint8_t *sys_status);
 bool 	anx7625_is_power_provider(uint8_t bus);
 
-#endif  /* _ANX7625_H */
+#endif  /* _ANX7625_H */
diff --git a/libraries/H7_Video/src/dsi.cpp b/libraries/H7_Video/src/dsi.cpp
@@ -1,18 +1,29 @@
+/**
+  ******************************************************************************
+  * @file    dsi.cpp
+  * @author  
+  * @version 
+  * @date    
+  * @brief   
+  ******************************************************************************
+  */
+
+/* Includes ------------------------------------------------------------------*/
 #include <Arduino.h>
 
 #include "dsi.h"
 #include "SDRAM.h"
 
-#define LCD_MAX_X_SIZE 1280
-#define LCD_MAX_Y_SIZE 1024
+/* Private define ------------------------------------------------------------*/
+#define LCD_MAX_X_SIZE 		1280
+#define LCD_MAX_Y_SIZE 		1024
 
 #define BYTES_PER_PIXEL		2
 #define FB_BASE_ADDRESS 	((uint32_t)SDRAM_START_ADDRESS)
 #define FB_ADDRESS_0 		(FB_BASE_ADDRESS)
 #define FB_ADDRESS_1 		(FB_BASE_ADDRESS + (LCD_MAX_X_SIZE * LCD_MAX_Y_SIZE * BYTES_PER_PIXEL))
 
-DSI_HandleTypeDef   dsi;
-
+/* Private variables ---------------------------------------------------------*/
 static DMA2D_HandleTypeDef dma2d;
 static LTDC_HandleTypeDef  ltdc;
 
@@ -24,9 +35,14 @@ static uint32_t __ALIGNED(32) L8_CLUT[256];
 
 static uint32_t pend_buffer = 0;
 
+/* Exported variables --------------------------------------------------------*/
+DSI_HandleTypeDef   dsi;
+
+/* Private function prototypes -----------------------------------------------*/
 static void dsi_fillBuffer(uint32_t LayerIndex, void *pDst, uint32_t xSize, uint32_t ySize, uint32_t OffLine, uint32_t ColorIndex);
 static void dsi_layerInit(uint16_t LayerIndex, uint32_t FB_Address);
 
+/* Functions -----------------------------------------------------------------*/
 int dsi_init(uint8_t bus, struct edid *edid, struct display_timing *dt) {
 #ifdef ARDUINO_GIGA
 	static const uint32_t DSI_PLLNDIV = 125;
@@ -357,4 +373,6 @@ void dsi_fillBuffer(uint32_t LayerIndex, void *pDst, uint32_t xSize, uint32_t yS
 			}
 		}
 	}
-}
+}
+
+/**** END OF FILE ****/
diff --git a/libraries/H7_Video/src/dsi.h b/libraries/H7_Video/src/dsi.h
@@ -1,8 +1,18 @@
+/**
+  ******************************************************************************
+  * @file    dsi.h
+  * @author  
+  * @version 
+  * @date    
+  * @brief   
+  ******************************************************************************
+  */
+
+/* Includes ------------------------------------------------------------------*/
 #ifndef _DSI_H
 #define _DSI_H
 
-extern DSI_HandleTypeDef dsi;
-
+/* Exported struct -----------------------------------------------------------*/
 struct display_timing {
 	unsigned int pixelclock;
 	unsigned int hactive;
@@ -17,16 +27,17 @@ struct display_timing {
 	unsigned int vpol : 1;
 };
 
-int                     dsi_init(uint8_t bus, struct edid *edid, struct display_timing *dt);
-
-void                    dsi_lcdClear(uint32_t color);
-void                    dsi_lcdDrawImage(void *pSrc, void *pDst, uint32_t xSize, uint32_t ySize, uint32_t ColorMode);
-void                    dsi_lcdFillArea(void *pDst, uint32_t xSize, uint32_t ySize, uint32_t ColorMode);
-
-void                    dsi_configueCLUT(uint32_t* clut);
+/* Exported variables --------------------------------------------------------*/
+extern DSI_HandleTypeDef dsi;
 
-uint32_t                dsi_getNextFrameBuffer(void);
-uint32_t                dsi_getCurrentFrameBuffer(void);
-uint32_t                dsi_getFramebufferEnd(void);
+/* Exported functions --------------------------------------------------------*/
+int			dsi_init(uint8_t bus, struct edid *edid, struct display_timing *dt);
+void		dsi_lcdClear(uint32_t color);
+void		dsi_lcdDrawImage(void *pSrc, void *pDst, uint32_t xSize, uint32_t ySize, uint32_t ColorMode);
+void		dsi_lcdFillArea(void *pDst, uint32_t xSize, uint32_t ySize, uint32_t ColorMode);
+void		dsi_configueCLUT(uint32_t* clut);
+uint32_t	dsi_getNextFrameBuffer(void);
+uint32_t	dsi_getCurrentFrameBuffer(void);
+uint32_t	dsi_getFramebufferEnd(void);
 
 #endif /* _DSI_H */
diff --git a/libraries/H7_Video/src/st7701.cpp b/libraries/H7_Video/src/st7701.cpp
@@ -1,8 +1,20 @@
+/**
+  ******************************************************************************
+  * @file    st7701.cpp
+  * @author  
+  * @version 
+  * @date    
+  * @brief   
+  ******************************************************************************
+  */
+
+/* Includes ------------------------------------------------------------------*/
 #include "Arduino.h"
 #include "st7701.h"
 #include "dsi.h"
 #include "video_modes.h"
 
+/* Private define ------------------------------------------------------------*/
 /* Command2 BKx selection command */
 #define DSI_CMD2BKX_SEL           0xFF
 #define DSI_CMD2BK1_SEL           0x11
@@ -31,28 +43,33 @@
 #define MIPI_DCS_SOFT_RESET       0x01
 #define MIPI_DCS_EXIT_SLEEP_MODE  0x11
 
+#define hdsi_eval                 dsi
+
+#define LCD_ST7701_ID             0x00  // VC (Virtual channel, for using muliple displays)
+
+#define Delay(x)                  delay(x)
+
+/* Private macro -------------------------------------------------------------*/
 #define SSD_MODE(a,b)
 #define Set_POWER(a,b,c,d)
 #define Set_STANDBY()
 #define Set_BOOST(a,b,c,d)
 #define Set_RESET(a,b)
 #define SSD_LANE(a,b)
 
-#define hdsi_eval   dsi
-
-#define LCD_ST7701_ID 0x00  // VC (Virtual channel, for using muliple displays)
-
-#define Delay(x)  delay(x)
-
+/* Private variables ---------------------------------------------------------*/
 const uint16_t _E5[17] = {0xE5,0x0E,0x2D,0xA0,0xa0,0x10,0x2D,0xA0,0xA0,0x0A,0x2D,0xA0,0xA0,0x0C,0x2D,0xA0,0xA0};
 const uint16_t _E8[17] = {0xE8,0x0D,0x2D,0xA0,0xA0,0x0F,0x2D,0xA0,0xA0,0x09,0x2D,0xA0,0xA0,0x0B,0x2D,0xA0,0xA0};
 const uint16_t _ED[17] = {0xED,0xAB,0x89,0x76,0x54,0x01,0xFF,0xFF,0xFF,0xFF,0xFF,0xFF,0x10,0x45,0x67,0x98,0xBA};
 
+/* Private function prototypes -----------------------------------------------*/
 static void Generic_Long_Write(uint8_t* pdata, int length);
 static void DCS_Short_Write_NP(uint8_t data0);
 static void Generic_Short_Write_1P(uint8_t data0, uint8_t data1);
 static void DCS_Short_Read_NP(uint8_t data0, int length, uint8_t* p_data);
 
+/* Functions -----------------------------------------------------------------*/
+
 void st7701_init(enum edid_modes mode) {
   struct edid _edid;
   struct display_timing dt;
@@ -241,4 +258,6 @@ void Generic_Long_Write(uint8_t* pdata, int length) {
 
 void DCS_Short_Read_NP(uint8_t data0, int length, uint8_t* p_data) {
   HAL_DSI_Read(&hdsi_eval, LCD_ST7701_ID, p_data, length, DSI_DCS_SHORT_PKT_READ, data0, NULL);
-}
+}
+
+/**** END OF FILE ****/
diff --git a/libraries/H7_Video/src/st7701.h b/libraries/H7_Video/src/st7701.h
diff --git a/libraries/H7_Video/src/video_modes.c b/libraries/H7_Video/src/video_modes.c
diff --git a/libraries/H7_Video/src/video_modes.h b/libraries/H7_Video/src/video_modes.h
