Files
esp-idf/components/esp_wifi/regulatory/reg2fw.py

117 lines
4.3 KiB
Python
Executable File

#!/usr/bin/env python
# SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD
# SPDX-License-Identifier: Apache-2.0
import os
from typing import List
from typing import TextIO
from reg_parse import DBParser
from reg_parse import Regdomain
def write_regulatory_rules(cfile: TextIO, perms: List, filter_5g: bool = False) -> None:
"""Helper function to write regulatory rules to the C file."""
filtered_perms = [perm for perm in perms if not filter_5g or (perm.freqband.start >= 1 and perm.freqband.end <= 14)]
rule_count = len(filtered_perms)
cfile.write(' {\n')
cfile.write(f' {rule_count}, /* Number of rules */\n')
cfile.write(' {\n')
for perm in filtered_perms:
cfile.write(
' {{ {start_chan}, {end_chan}, {max_bandwidth}, {max_eirp}, {is_dfs}, {reserved} }}, '
'/* chan:{start_chan}~{end_chan}, '
'max_bw:{bandwidth_comment}, max_power:{max_eirp}(dBm), '
'dfs:{is_dfs}, reserved.*/\n'.format(
start_chan=int(perm.freqband.start),
end_chan=int(perm.freqband.end),
max_bandwidth=int(perm.freqband.maxbw),
max_eirp=int(perm.power.max_eirp),
is_dfs=perm.dfs,
reserved=0,
bandwidth_comment={1: '20M', 2: '40M', 3: '80M', 4: '160M'}.get(int(perm.freqband.maxbw), 'Unknown'),
)
)
cfile.write(' }\n')
cfile.write(' },\n')
def write_regulatory_data(
cfile: TextIO, reg: Regdomain, type_list: List[str], perm_list: List[List], filter_5g: bool
) -> None:
"""Helper function to write regulatory data."""
cfile.write('typedef enum {\n')
for reg_type in type_list:
cfile.write(f' ESP_WIFI_REGULATORY_TYPE_{reg_type},\n')
cfile.write(' ESP_WIFI_REGULATORY_TYPE_MAX,\n')
cfile.write('} esp_wifi_regulatory_type_t;\n\n')
cfile.write('const wifi_regdomain_t regdomain_table[WIFI_MAX_SUPPORT_COUNTRY_NUM] = {\n')
country_map = reg.regdomain_countries if filter_5g else reg.regdomain_countries_2g
for cc, reg_type_index in country_map.items():
reg_type = f'ESP_WIFI_REGULATORY_TYPE_{type_list[reg_type_index]}'
cfile.write(f' {{"{cc.decode("utf-8")}", {reg_type}}},\n')
cfile.write('};\n\n')
cfile.write('const wifi_regulatory_t regulatory_data[] = {\n')
for perms in perm_list:
index = perm_list.index(perms)
regulatory_type = f'ESP_WIFI_REGULATORY_TYPE_{type_list[index]}'
cfile.write(f' /* {regulatory_type} */\n')
write_regulatory_rules(cfile, perms, not filter_5g)
cfile.write('};\n')
def main() -> None:
p = DBParser()
reg = Regdomain()
filename = 'esp_wifi_regulatory.txt'
directory = os.path.dirname(os.path.abspath(__file__))
file_path = os.path.join(directory, filename)
try:
with open(file_path, 'r', encoding='utf-8') as file:
regdomains = p.parse(file)
except FileNotFoundError:
raise Exception(f'File {file_path} not found')
reg.simplify_countries(regdomains)
reg.simplify_countries_2g(regdomains)
type_list = list(reg.typical_regulatory.keys())
perm_list = list(reg.typical_regulatory.values())
type_list_2g = list(reg.typical_regulatory_2g.keys())
perm_list_2g = list(reg.typical_regulatory_2g.values())
output_file = 'esp_wifi_regulatory.c'
with open(output_file, 'w') as cfile:
cfile.write('/*\n')
cfile.write(' * SPDX-FileCopyrightText: 2025 Espressif Systems (Shanghai) CO LTD\n')
cfile.write(' *\n')
cfile.write(' * SPDX-License-Identifier: Apache-2.0\n')
cfile.write(' */\n\n')
cfile.write('#include <stdint.h>\n')
cfile.write('#include "esp_wifi_types_generic.h"\n')
cfile.write('#include "esp_wifi.h"\n\n')
# Write for 5G support
cfile.write('#ifdef CONFIG_SOC_WIFI_SUPPORT_5G\n')
write_regulatory_data(cfile, reg, type_list, perm_list, filter_5g=True)
cfile.write('#else\n')
# Write for 2G only
write_regulatory_data(cfile, reg, type_list_2g, perm_list_2g, filter_5g=False)
cfile.write('#endif // CONFIG_SOC_WIFI_SUPPORT_5G\n')
print(f'{output_file} generated successfully.')
if __name__ == '__main__':
main()