From 6ea58346c6ab69d28e7c12e042e10dc6cbba5f90 Mon Sep 17 00:00:00 2001 From: Jan Samek Date: Wed, 18 Jan 2023 11:59:14 +0100 Subject: [PATCH] mb/siemens: Unify and clean lcd_panel.c coding style With the addition of the mc_ehl3 board variant, a few points about commenting the code arose either from the review or during the implementation itself. This patch unifies structure of these files, which have a similar structure across more Siemens boards utilizing the PTN3460 eDP-to-LVDS bridge. BUG=none TEST=Check that images for the affected boards can be built. Change-Id: I59820362e1f87e296c5548b9c3cecba4d2710fe7 Signed-off-by: Jan Samek Reviewed-on: https://review.coreboot.org/c/coreboot/+/72068 Reviewed-by: Werner Zeh Tested-by: build bot (Jenkins) --- .../mc_apl1/variants/mc_apl1/lcd_panel.c | 50 ++++++++++-------- .../mc_apl1/variants/mc_apl4/lcd_panel.c | 49 ++++++++++-------- .../mc_apl1/variants/mc_apl5/lcd_panel.c | 51 ++++++++++--------- .../mc_apl1/variants/mc_apl7/lcd_panel.c | 49 ++++++++++-------- .../mc_ehl/variants/mc_ehl3/lcd_panel.c | 34 +++++++------ 5 files changed, 128 insertions(+), 105 deletions(-) diff --git a/src/mainboard/siemens/mc_apl1/variants/mc_apl1/lcd_panel.c b/src/mainboard/siemens/mc_apl1/variants/mc_apl1/lcd_panel.c index 64d98485f7..b6e3c27c75 100644 --- a/src/mainboard/siemens/mc_apl1/variants/mc_apl1/lcd_panel.c +++ b/src/mainboard/siemens/mc_apl1/variants/mc_apl1/lcd_panel.c @@ -6,9 +6,10 @@ #include #include -/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460) - * @param edid_data pointer to EDID data in driver -*/ +/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460). + * @param edid_data pointer to EDID data in driver + * @return CB_SUCCESS on successful EDID data retrieval, CB_ERR otherwise + */ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) { const char *hwi_block = "hwinfo.hex"; @@ -28,26 +29,28 @@ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) /** \brief This function provides EDID block [0..6] to the driver for DP2LVDS Bridge (PTN3460) * which has to be used. -*/ + * @return Index of the EDID slot selected for EDID emulation + */ uint8_t mb_select_edid_table(void) { return 6; /* With this mainboard we use EDID block 6 for emulation in PTN3460. */ } -/** \brief Function to enable mainboard to adjust the config data of PTN3460. - * @param *cfg_ptr Pointer to the PTN config structure to modify. +/** \brief Function to enable mainboard to adjust the config data of PTN3460. For reference, + * see NXP document AN11128 - PTN3460 Programming guide. + * @param *cfg_ptr Pointer to the PTN config structure to modify * @return -1 on error; PTN_CFG_MODIFIED if data was modified and needs to be updated. -*/ + */ int mb_adjust_cfg(struct ptn_3460_config *cfg) { const char *hwi_block = "hwinfo.hex"; uint8_t disp_con = 0, color_depth = 0; + /* Get display-specific configuration from hwinfo. */ if (hwilib_find_blocks(hwi_block) != CB_SUCCESS) { printk(BIOS_ERR, "LCD: Info block \"%s\" not found!\n", hwi_block); return -1; } - if (hwilib_get_field(PF_DisplCon, &disp_con, sizeof(disp_con)) != sizeof(disp_con)) { printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; @@ -57,8 +60,11 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; } - /* Set up configuration data according to the hwinfo block we got. */ + + /* Set up PTN3460 registers based on hwinfo and fixed board-specific parameters: */ + /* Use 2 lanes for eDP, no P/N swapping, no ASSR, allow both HBR and RBR modes. */ cfg->dp_interface_ctrl = 0x00; + /* Use even bus for LVDS clock distribution only. */ cfg->lvds_interface_ctrl1 = 0x00; if (disp_con == PF_DISPLCON_LVDS_DUAL) { /* Turn on dual LVDS lane and clock. */ @@ -68,22 +74,22 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) /* Use 18 bits per pixel. */ cfg->lvds_interface_ctrl1 |= 0x20; } - /* 1 % clock spreading, 300 mV LVDS swing. */ + /* 1% clock spreading, 300 mV LVDS swing */ cfg->lvds_interface_ctrl2 = 0x13; - /* No LVDS lane swap. */ + /* No LVDS lane/channel swapping */ cfg->lvds_interface_ctrl3 = 0x00; - /* Delay T2 (VDD to LVDS active) by 16 ms. */ - cfg->t2_delay = 1; - /* 500 ms from LVDS to backlight active. */ - cfg->t3_timing = 10; - /* 1 second re-power delay. */ - cfg->t12_timing = 20; - /* 150 ms backlight off to LVDS inactive. */ - cfg->t4_timing = 3; - /* Delay T5 (LVDS to VDD inactive) by 16 ms. */ - cfg->t5_delay = 1; + /* Enable VDD to LVDS active delay. */ + cfg->t2_delay = 0x01; + /* LVDS to backlight active delay: 500 ms */ + cfg->t3_timing = 0x0a; + /* Minimum re-power delay: 1 s */ + cfg->t12_timing = 0x14; + /* Backlight off to LVDS inactive delay: 150 ms */ + cfg->t4_timing = 0x03; + /* Enable LVDS to VDD inactive delay. */ + cfg->t5_delay = 0x01; /* Enable backlight control. */ - cfg->backlight_ctrl = 0; + cfg->backlight_ctrl = 0x00; return PTN_CFG_MODIFIED; } diff --git a/src/mainboard/siemens/mc_apl1/variants/mc_apl4/lcd_panel.c b/src/mainboard/siemens/mc_apl1/variants/mc_apl4/lcd_panel.c index c1dc0bd239..9fd2566456 100644 --- a/src/mainboard/siemens/mc_apl1/variants/mc_apl4/lcd_panel.c +++ b/src/mainboard/siemens/mc_apl1/variants/mc_apl4/lcd_panel.c @@ -6,9 +6,10 @@ #include #include -/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460) - * @param edid_data pointer to EDID data in driver -*/ +/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460). + * @param edid_data pointer to EDID data in driver + * @return CB_SUCCESS on successful EDID data retrieval, CB_ERR otherwise + */ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) { const char *hwi_block = "hwinfo.hex"; @@ -28,26 +29,28 @@ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) /** \brief This function provides EDID block [0..6] to the driver for DP2LVDS Bridge (PTN3460) * which has to be used. -*/ + * @return Index of the EDID slot selected for EDID emulation + */ uint8_t mb_select_edid_table(void) { return 6; /* With this mainboard we use EDID block 6 for emulation in PTN3460. */ } -/** \brief Function to enable mainboard to adjust the config data of PTN3460. - * @param *cfg_ptr Pointer to the PTN config structure to modify. +/** \brief Function to enable mainboard to adjust the config data of PTN3460. For reference, + * see NXP document AN11128 - PTN3460 Programming guide. + * @param *cfg_ptr Pointer to the PTN config structure to modify * @return -1 on error; PTN_CFG_MODIFIED if data was modified and needs to be updated. -*/ + */ int mb_adjust_cfg(struct ptn_3460_config *cfg) { const char *hwi_block = "hwinfo.hex"; uint8_t disp_con = 0, color_depth = 0; + /* Get display-specific configuration from hwinfo. */ if (hwilib_find_blocks(hwi_block) != CB_SUCCESS) { printk(BIOS_ERR, "LCD: Info block \"%s\" not found!\n", hwi_block); return -1; } - if (hwilib_get_field(PF_DisplCon, &disp_con, sizeof(disp_con)) != sizeof(disp_con)) { printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; @@ -57,9 +60,11 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; } - /* Set up configuration data according to the hwinfo block we got. */ + + /* Set up PTN3460 registers based on hwinfo and fixed board-specific parameters: */ + /* Use 2 lanes for eDP, no P/N swapping, no ASSR, allow both HBR and RBR modes. */ cfg->dp_interface_ctrl = 0x00; - /* Use odd-bus for clock distribution only. */ + /* Use odd bus for LVDS clock distribution only. */ cfg->lvds_interface_ctrl1 = 0x01; if (disp_con == PF_DISPLCON_LVDS_DUAL) { /* Turn on dual LVDS lane and clock. */ @@ -69,22 +74,22 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) /* Use 18 bits per pixel. */ cfg->lvds_interface_ctrl1 |= 0x20; } - /* No clock spreading, 300 mV LVDS swing. */ + /* No clock spreading, 300 mV LVDS swing */ cfg->lvds_interface_ctrl2 = 0x03; /* Swap LVDS lanes (N vs. P). */ cfg->lvds_interface_ctrl3 = 0x04; - /* Delay T2 (VDD to LVDS active) by 16 ms. */ - cfg->t2_delay = 1; - /* 500 ms from LVDS to backlight active. */ - cfg->t3_timing = 10; - /* 1 second re-power delay. */ - cfg->t12_timing = 20; - /* 150 ms backlight off to LVDS inactive. */ - cfg->t4_timing = 3; - /* Delay T5 (LVDS to VDD inactive) by 16 ms. */ - cfg->t5_delay = 1; + /* Enable VDD to LVDS active delay. */ + cfg->t2_delay = 0x01; + /* LVDS to backlight active delay: 500 ms */ + cfg->t3_timing = 0x0a; + /* Minimum re-power delay: 1 s */ + cfg->t12_timing = 0x14; + /* Backlight off to LVDS inactive delay: 150 ms */ + cfg->t4_timing = 0x03; + /* Enable LVDS to VDD inactive delay. */ + cfg->t5_delay = 0x01; /* Enable backlight control. */ - cfg->backlight_ctrl = 0; + cfg->backlight_ctrl = 0x00; return PTN_CFG_MODIFIED; } diff --git a/src/mainboard/siemens/mc_apl1/variants/mc_apl5/lcd_panel.c b/src/mainboard/siemens/mc_apl1/variants/mc_apl5/lcd_panel.c index b667cb8d38..c984f2fed4 100644 --- a/src/mainboard/siemens/mc_apl1/variants/mc_apl5/lcd_panel.c +++ b/src/mainboard/siemens/mc_apl1/variants/mc_apl5/lcd_panel.c @@ -29,9 +29,10 @@ static void igd_disable(void) pci_write_config8(root_dev, 0x54, deven); } -/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460) - * @param edid_data pointer to EDID data in driver -*/ +/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460). + * @param edid_data pointer to EDID data in driver + * @return CB_SUCCESS on successful EDID data retrieval, CB_ERR otherwise + */ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) { const char *hwi_block = "hwinfo.hex"; @@ -53,26 +54,28 @@ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) /** \brief This function provides EDID block [0..6] to the driver for DP2LVDS Bridge (PTN3460) * which has to be used. -*/ + * @return Index of the EDID slot selected for EDID emulation + */ uint8_t mb_select_edid_table(void) { return 6; /* With this mainboard we use EDID block 6 for emulation in PTN3460. */ } -/** \brief Function to enable mainboard to adjust the config data of PTN3460. - * @param *cfg_ptr Pointer to the PTN config structure to modify. +/** \brief Function to enable mainboard to adjust the config data of PTN3460. For reference, + * see NXP document AN11128 - PTN3460 Programming guide. + * @param *cfg_ptr Pointer to the PTN config structure to modify * @return -1 on error; PTN_CFG_MODIFIED if data was modified and needs to be updated. -*/ + */ int mb_adjust_cfg(struct ptn_3460_config *cfg) { const char *hwi_block = "hwinfo.hex"; uint8_t disp_con = 0, color_depth = 0; + /* Get display-specific configuration from hwinfo. */ if (hwilib_find_blocks(hwi_block) != CB_SUCCESS) { printk(BIOS_ERR, "LCD: Info block \"%s\" not found!\n", hwi_block); return -1; } - if (hwilib_get_field(PF_DisplCon, &disp_con, sizeof(disp_con)) != sizeof(disp_con)) { printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; @@ -82,9 +85,11 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; } - /* Set up configuration data according to the hwinfo block we got. */ + + /* Set up PTN3460 registers based on hwinfo and fixed board-specific parameters: */ + /* Use 2 lanes for eDP, no P/N swapping, no ASSR, allow both HBR and RBR modes. */ cfg->dp_interface_ctrl = 0x00; - /* Drive LVDS clock for single mode on odd bus per default. */ + /* Use odd bus for LVDS clock distribution only. */ cfg->lvds_interface_ctrl1 = 0x01; if (disp_con == PF_DISPLCON_LVDS_DUAL) { /* Turn on dual LVDS lane and clock. */ @@ -94,22 +99,22 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) /* Use 18 bits per pixel. */ cfg->lvds_interface_ctrl1 |= 0x20; } - /* 1 % clock spreading, 300 mV LVDS swing. */ + /* 1% clock spreading, 300 mV LVDS swing */ cfg->lvds_interface_ctrl2 = 0x13; - /* No LVDS lane swap. */ + /* No LVDS lane/channel swapping */ cfg->lvds_interface_ctrl3 = 0x00; - /* Delay T2 (VDD to LVDS active) by 16 ms. */ - cfg->t2_delay = 1; - /* 500 ms from LVDS to backlight active. */ - cfg->t3_timing = 10; - /* 1 second re-power delay. */ - cfg->t12_timing = 20; - /* 150 ms backlight off to LVDS inactive. */ - cfg->t4_timing = 3; - /* Delay T5 (LVDS to VDD inactive) by 16 ms. */ - cfg->t5_delay = 1; + /* Enable VDD to LVDS active delay. */ + cfg->t2_delay = 0x01; + /* LVDS to backlight active delay: 500 ms */ + cfg->t3_timing = 0x0a; + /* Minimum re-power delay: 1 s */ + cfg->t12_timing = 0x14; + /* Backlight off to LVDS inactive delay: 150 ms */ + cfg->t4_timing = 0x03; + /* Enable LVDS to VDD inactive delay. */ + cfg->t5_delay = 0x01; /* Enable backlight control. */ - cfg->backlight_ctrl = 0; + cfg->backlight_ctrl = 0x00; return PTN_CFG_MODIFIED; } diff --git a/src/mainboard/siemens/mc_apl1/variants/mc_apl7/lcd_panel.c b/src/mainboard/siemens/mc_apl1/variants/mc_apl7/lcd_panel.c index c1dc0bd239..9fd2566456 100644 --- a/src/mainboard/siemens/mc_apl1/variants/mc_apl7/lcd_panel.c +++ b/src/mainboard/siemens/mc_apl1/variants/mc_apl7/lcd_panel.c @@ -6,9 +6,10 @@ #include #include -/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460) - * @param edid_data pointer to EDID data in driver -*/ +/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460). + * @param edid_data pointer to EDID data in driver + * @return CB_SUCCESS on successful EDID data retrieval, CB_ERR otherwise + */ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) { const char *hwi_block = "hwinfo.hex"; @@ -28,26 +29,28 @@ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) /** \brief This function provides EDID block [0..6] to the driver for DP2LVDS Bridge (PTN3460) * which has to be used. -*/ + * @return Index of the EDID slot selected for EDID emulation + */ uint8_t mb_select_edid_table(void) { return 6; /* With this mainboard we use EDID block 6 for emulation in PTN3460. */ } -/** \brief Function to enable mainboard to adjust the config data of PTN3460. - * @param *cfg_ptr Pointer to the PTN config structure to modify. +/** \brief Function to enable mainboard to adjust the config data of PTN3460. For reference, + * see NXP document AN11128 - PTN3460 Programming guide. + * @param *cfg_ptr Pointer to the PTN config structure to modify * @return -1 on error; PTN_CFG_MODIFIED if data was modified and needs to be updated. -*/ + */ int mb_adjust_cfg(struct ptn_3460_config *cfg) { const char *hwi_block = "hwinfo.hex"; uint8_t disp_con = 0, color_depth = 0; + /* Get display-specific configuration from hwinfo. */ if (hwilib_find_blocks(hwi_block) != CB_SUCCESS) { printk(BIOS_ERR, "LCD: Info block \"%s\" not found!\n", hwi_block); return -1; } - if (hwilib_get_field(PF_DisplCon, &disp_con, sizeof(disp_con)) != sizeof(disp_con)) { printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; @@ -57,9 +60,11 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) printk(BIOS_ERR, "LCD: Missing panel features from %s\n", hwi_block); return -1; } - /* Set up configuration data according to the hwinfo block we got. */ + + /* Set up PTN3460 registers based on hwinfo and fixed board-specific parameters: */ + /* Use 2 lanes for eDP, no P/N swapping, no ASSR, allow both HBR and RBR modes. */ cfg->dp_interface_ctrl = 0x00; - /* Use odd-bus for clock distribution only. */ + /* Use odd bus for LVDS clock distribution only. */ cfg->lvds_interface_ctrl1 = 0x01; if (disp_con == PF_DISPLCON_LVDS_DUAL) { /* Turn on dual LVDS lane and clock. */ @@ -69,22 +74,22 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) /* Use 18 bits per pixel. */ cfg->lvds_interface_ctrl1 |= 0x20; } - /* No clock spreading, 300 mV LVDS swing. */ + /* No clock spreading, 300 mV LVDS swing */ cfg->lvds_interface_ctrl2 = 0x03; /* Swap LVDS lanes (N vs. P). */ cfg->lvds_interface_ctrl3 = 0x04; - /* Delay T2 (VDD to LVDS active) by 16 ms. */ - cfg->t2_delay = 1; - /* 500 ms from LVDS to backlight active. */ - cfg->t3_timing = 10; - /* 1 second re-power delay. */ - cfg->t12_timing = 20; - /* 150 ms backlight off to LVDS inactive. */ - cfg->t4_timing = 3; - /* Delay T5 (LVDS to VDD inactive) by 16 ms. */ - cfg->t5_delay = 1; + /* Enable VDD to LVDS active delay. */ + cfg->t2_delay = 0x01; + /* LVDS to backlight active delay: 500 ms */ + cfg->t3_timing = 0x0a; + /* Minimum re-power delay: 1 s */ + cfg->t12_timing = 0x14; + /* Backlight off to LVDS inactive delay: 150 ms */ + cfg->t4_timing = 0x03; + /* Enable LVDS to VDD inactive delay. */ + cfg->t5_delay = 0x01; /* Enable backlight control. */ - cfg->backlight_ctrl = 0; + cfg->backlight_ctrl = 0x00; return PTN_CFG_MODIFIED; } diff --git a/src/mainboard/siemens/mc_ehl/variants/mc_ehl3/lcd_panel.c b/src/mainboard/siemens/mc_ehl/variants/mc_ehl3/lcd_panel.c index bd21460f60..b1c4e0100c 100644 --- a/src/mainboard/siemens/mc_ehl/variants/mc_ehl3/lcd_panel.c +++ b/src/mainboard/siemens/mc_ehl/variants/mc_ehl3/lcd_panel.c @@ -6,9 +6,10 @@ #include #include -/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460) - * @param edid_data pointer to EDID data in driver -*/ +/** \brief This function provides EDID data to the driver for DP2LVDS Bridge (PTN3460). + * @param edid_data pointer to EDID data in driver + * @return CB_SUCCESS on successful EDID data retrieval, CB_ERR otherwise + */ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) { const char *hwi_block = "hwinfo.hex"; @@ -28,16 +29,18 @@ enum cb_err mb_get_edid(uint8_t edid_data[0x80]) /** \brief This function provides EDID block [0..6] to the driver for DP2LVDS Bridge (PTN3460) * which has to be used. -*/ + * @return Index of the EDID slot selected for EDID emulation + */ uint8_t mb_select_edid_table(void) { return 6; /* With this mainboard we use EDID block 6 for emulation in PTN3460. */ } -/** \brief Function to enable mainboard to adjust the config data of PTN3460. - * @param *cfg_ptr Pointer to the PTN config structure to modify. +/** \brief Function to enable mainboard to adjust the config data of PTN3460. For reference, + * see NXP document AN11128 - PTN3460 Programming guide. + * @param *cfg_ptr Pointer to the PTN config structure to modify * @return -1 on error; PTN_CFG_MODIFIED if data was modified and needs to be updated. -*/ + */ int mb_adjust_cfg(struct ptn_3460_config *cfg) { const char *hwi_block = "hwinfo.hex"; @@ -58,9 +61,10 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) return -1; } - /* Set up configuration data according to the hwinfo block we got. */ + /* Set up PTN3460 registers based on hwinfo and fixed board-specific parameters: */ + /* Use 2 lanes for eDP, no P/N swapping, no ASSR, allow both HBR and RBR modes. */ cfg->dp_interface_ctrl = 0x00; - /* Use odd-bus for clock distribution only. */ + /* Use odd bus for LVDS clock distribution only. */ cfg->lvds_interface_ctrl1 = 0x01; if (disp_con == PF_DISPLCON_LVDS_DUAL) { /* Turn on dual LVDS lane and clock. */ @@ -70,19 +74,17 @@ int mb_adjust_cfg(struct ptn_3460_config *cfg) /* Use 18 bits per pixel. */ cfg->lvds_interface_ctrl1 |= 0x20; } - - /* Set up remaining board-specific LVDS parameters: */ - /* No clock spreading, 300 mV LVDS swing. */ + /* No LVDS clock spreading, 300 mV LVDS swing */ cfg->lvds_interface_ctrl2 = 0x03; - /* No lane/channel swapping */ + /* No LVDS lane/channel swapping */ cfg->lvds_interface_ctrl3 = 0x00; - /* Enable VDD to LVDS active delay (16 ms). */ + /* Enable VDD to LVDS active delay. */ cfg->t2_delay = 0x01; - /* LVDS to backlight active delay: 200 ms. */ + /* LVDS to backlight active delay: 200 ms */ cfg->t3_timing = 0x04; /* Minimum re-power delay: 500 ms */ cfg->t12_timing = 0x0a; - /* Backlight off to LVDS inactive delay: 200 ms. */ + /* Backlight off to LVDS inactive delay: 200 ms */ cfg->t4_timing = 0x04; /* Enable LVDS to VDD inactive delay. */ cfg->t5_delay = 0x01;