summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJeremy Compostella <jeremy.compostella@intel.com>2024-09-26 10:50:09 -0700
committerSubrata Banik <subratabanik@google.com>2024-09-27 17:04:24 +0000
commit2a3b9b2ad5849fa3980196f8733548b8976d804a (patch)
tree650cff0963d5572a4c9c613294180c865d46c68b
parentb29b66c5f5935e0dfab18cca10b69101b75ce508 (diff)
soc/intel/pantherlake: Comply with the no typedef coding style rule
As https://doc.coreboot.org/contributing/coding_style.html#typedefs states: "In general, a pointer, or a struct that has elements that can reasonably be directly accessed should never be a typedef". This commit makes the Intel Panther Lake SoC code comply with this by using explicitly `struct soc_intel_pantherlake_config' in the soc/intel/pantherlake code as I have been suggested to for the `fsp_params.c' files. The rule being the rule and consistency across a project matters more than personal preferences. The documentation lists five exceptions and none on them cover the use of `config_t' instead `struct soc_intel_pantherlake' but I believe it does not make the code better for the following three reasons: 1. It is repetitive, make the line longer and the code is in soc/intel/pantherlake so obviously the config_t data structure is the pantherlake soc configuration. 2. It makes re-usability from one generation to another unnecessarily harder. 3. This config_t abstraction is required for and used by some common block code anyway. Hence, we end-up with some code using `config_t' and other using the final structure which break the consistency of the code when the project in looked as a whole. BUG=348678529 TEST=Google fatcat mainboard compiles Change-Id: Ibe382615db1a7c7a0841d8fe4ae43c226e2c2021 Signed-off-by: Jeremy Compostella <jeremy.compostella@intel.com> Reviewed-on: https://review.coreboot.org/c/coreboot/+/84561 Tested-by: build bot (Jenkins) <no-reply@coreboot.org> Reviewed-by: Subrata Banik <subratabanik@google.com> Reviewed-by: Ronak Kanabar <ronak.kanabar@intel.com>
-rw-r--r--src/soc/intel/pantherlake/acpi.c8
-rw-r--r--src/soc/intel/pantherlake/chip.c4
-rw-r--r--src/soc/intel/pantherlake/cpu.c6
-rw-r--r--src/soc/intel/pantherlake/espi.c2
-rw-r--r--src/soc/intel/pantherlake/pmc.c2
-rw-r--r--src/soc/intel/pantherlake/systemagent.c2
6 files changed, 12 insertions, 12 deletions
diff --git a/src/soc/intel/pantherlake/acpi.c b/src/soc/intel/pantherlake/acpi.c
index 79e47e805e..fd17ef5ae2 100644
--- a/src/soc/intel/pantherlake/acpi.c
+++ b/src/soc/intel/pantherlake/acpi.c
@@ -126,7 +126,7 @@ const acpi_cstate_t *soc_get_cstate_map(size_t *entries)
if (c_state_initialized)
return map;
- config_t *config = config_of_soc();
+ const struct soc_intel_pantherlake_config *config = config_of_soc();
if (config == NULL) {
printk(BIOS_ERR, "Error: Configuration could not be retrieved.\n");
return NULL;
@@ -152,7 +152,7 @@ const acpi_cstate_t *soc_get_cstate_map(size_t *entries)
void soc_power_states_generation(int core_id, int cores_per_package)
{
- config_t *config = config_of_soc();
+ const struct soc_intel_pantherlake_config *config = config_of_soc();
if (config == NULL) {
printk(BIOS_ERR, "Error: Configuration could not be retrieved.\n");
return;
@@ -166,7 +166,7 @@ void soc_fill_fadt(acpi_fadt_t *fadt)
{
const uint16_t pmbase = ACPI_BASE_ADDRESS;
- config_t *config = config_of_soc();
+ const struct soc_intel_pantherlake_config *config = config_of_soc();
if (config == NULL) {
printk(BIOS_ERR, "Error: Configuration could not be retrieved.\n");
return;
@@ -339,7 +339,7 @@ unsigned long sa_write_acpi_tables(const struct device *dev, unsigned long curre
void soc_fill_gnvs(struct global_nvs *gnvs)
{
- config_t *config = config_of_soc();
+ const struct soc_intel_pantherlake_config *config = config_of_soc();
if (config == NULL) {
printk(BIOS_ERR, "Configuration could not be retrieved.\n");
return;
diff --git a/src/soc/intel/pantherlake/chip.c b/src/soc/intel/pantherlake/chip.c
index 6b596b0558..4e7d5733f7 100644
--- a/src/soc/intel/pantherlake/chip.c
+++ b/src/soc/intel/pantherlake/chip.c
@@ -139,7 +139,7 @@ bool soc_is_ish_partition_enabled(void)
static void soc_fill_gpio_pm_configuration(void)
{
uint8_t value[TOTAL_GPIO_COMM];
- const config_t *config = config_of_soc();
+ const struct soc_intel_pantherlake_config *config = config_of_soc();
if (config->gpio_override_pm)
memcpy(value, config->gpio_pm, sizeof(value));
@@ -163,7 +163,7 @@ static void soc_enable_tracehub(void)
void soc_init_pre_device(void *chip_info)
{
- config_t *config = config_of_soc();
+ struct soc_intel_pantherlake_config *config = config_of_soc();
if (config == NULL) {
printk(BIOS_ERR, "Error: Configuration could not be retrieved.\n");
return;
diff --git a/src/soc/intel/pantherlake/cpu.c b/src/soc/intel/pantherlake/cpu.c
index 13a1d9ea24..7856383339 100644
--- a/src/soc/intel/pantherlake/cpu.c
+++ b/src/soc/intel/pantherlake/cpu.c
@@ -53,7 +53,7 @@ static void configure_misc(void)
{
msr_t msr;
- config_t *conf = (config_t *)config_of_soc();
+ const struct soc_intel_pantherlake_config *conf = config_of_soc();
msr = rdmsr(IA32_MISC_ENABLE);
msr.lo |= FAST_STRINGS_ENABLE_BIT;
@@ -123,7 +123,7 @@ void soc_core_init(struct device *cpu)
/* Set energy policy */
set_energy_perf_bias(ENERGY_POLICY_NORMAL);
- const config_t *conf = config_of_soc();
+ const struct soc_intel_pantherlake_config *conf = config_of_soc();
/* Set energy-performance preference */
if (conf != NULL && conf->enable_energy_perf_pref) {
if (check_energy_perf_cap())
@@ -152,7 +152,7 @@ static void pre_mp_init(void)
{
soc_fsp_load();
- const config_t *conf = config_of_soc();
+ const struct soc_intel_pantherlake_config *conf = config_of_soc();
if (conf == NULL) {
printk(BIOS_ERR, "Configuration could not be retrieved.\n");
return;
diff --git a/src/soc/intel/pantherlake/espi.c b/src/soc/intel/pantherlake/espi.c
index a3952a31aa..02bec6f197 100644
--- a/src/soc/intel/pantherlake/espi.c
+++ b/src/soc/intel/pantherlake/espi.c
@@ -16,7 +16,7 @@
void soc_get_gen_io_dec_range(uint32_t gen_io_dec[LPC_NUM_GENERIC_IO_RANGES])
{
- const config_t *config = config_of_soc();
+ const struct soc_intel_pantherlake_config *config = config_of_soc();
gen_io_dec[0] = config->gen1_dec;
gen_io_dec[1] = config->gen2_dec;
diff --git a/src/soc/intel/pantherlake/pmc.c b/src/soc/intel/pantherlake/pmc.c
index 91aeecd22b..1c1ca5dec0 100644
--- a/src/soc/intel/pantherlake/pmc.c
+++ b/src/soc/intel/pantherlake/pmc.c
@@ -66,7 +66,7 @@ static void config_deep_sx(uint32_t deepsx_config)
static void soc_pmc_enable(struct device *dev)
{
- const config_t *config = config_of_soc();
+ const struct soc_intel_pantherlake_config *config = config_of_soc();
rtc_init();
diff --git a/src/soc/intel/pantherlake/systemagent.c b/src/soc/intel/pantherlake/systemagent.c
index b325e909ce..418f41cd2f 100644
--- a/src/soc/intel/pantherlake/systemagent.c
+++ b/src/soc/intel/pantherlake/systemagent.c
@@ -144,7 +144,7 @@ static void configure_tdp(struct device *dev)
u8 tdp;
size_t i;
bool config_tdp = false;
- config_t *config;
+ struct soc_intel_pantherlake_config *config;
config = config_of_soc();