mirror of
https://github.com/ByteWelder/Tactility.git
synced 2026-02-18 19:03:16 +00:00
4b6ed871a9
**New features** - Created a devicetree DTS and YAML parser in Python - Created new modules: - TactilityKernel (LGPL v3.0 license) - Platforms/PlatformEsp32 (LGPL v3.0 license) - Platforms/PlatformPosix (LGPL v3.0 license) - Tests/TactilityKernelTests Most boards have a placeholder DTS file, while T-Lora Pager has a few devices attached. **Licenses** Clarified licenses and copyrights better. - Add explanation about the intent behind them. - Added explanation about licenses for past and future subprojects - Added more details explanations with regards to the logo usage - Copied licenses to subprojects to make it more explicit
218 lines
8.5 KiB
Python
218 lines
8.5 KiB
Python
import os.path
|
|
from textwrap import dedent
|
|
|
|
from source.models import *
|
|
|
|
def write_include(file, include: IncludeC, verbose: bool):
|
|
if verbose:
|
|
print("Processing include:")
|
|
print(f" {include.statement}")
|
|
file.write(include.statement)
|
|
file.write('\n')
|
|
|
|
def get_device_identifier_safe(device: Device):
|
|
if device.identifier == "/":
|
|
return "root"
|
|
else:
|
|
return device.identifier
|
|
|
|
def get_device_type_name(device: Device, bindings: list[Binding]):
|
|
device_binding = find_device_binding(device, bindings)
|
|
if device_binding is None:
|
|
raise Exception(f"Binding not found for {device.identifier}")
|
|
if device_binding.compatible is None:
|
|
raise Exception(f"Couldn't find compatible binding for {device.identifier}")
|
|
compatible_safe = device_binding.compatible.split(",")[-1]
|
|
return compatible_safe.replace("-", "_")
|
|
|
|
def find_device_property(device: Device, name: str) -> DeviceProperty:
|
|
for property in device.properties:
|
|
if property.name == name:
|
|
return property
|
|
return None
|
|
|
|
def find_device_binding(device: Device, bindings: list[Binding]) -> Binding:
|
|
compatible_property = find_device_property(device, "compatible")
|
|
if compatible_property is None:
|
|
raise Exception(f"property 'compatible' not found in device {device.identifier}")
|
|
for binding in bindings:
|
|
if binding.compatible == compatible_property.value:
|
|
return binding
|
|
return None
|
|
|
|
def find_binding(compatible: str, bindings: list[Binding]) -> Binding:
|
|
for binding in bindings:
|
|
if binding.compatible == compatible:
|
|
return binding
|
|
return None
|
|
|
|
def property_to_string(property: DeviceProperty) -> str:
|
|
type = property.type
|
|
if type == "value":
|
|
return property.value
|
|
elif type == "text":
|
|
return f"\"{property.value}\""
|
|
elif type == "values":
|
|
return "{ " + ",".join(property.value) + " }"
|
|
else:
|
|
raise Exception(f"property_to_string() has an unsupported type: {type}")
|
|
|
|
def resolve_parameters_from_bindings(device: Device, bindings: list[Binding]) -> list:
|
|
compatible_property = find_device_property(device, "compatible")
|
|
if compatible_property is None:
|
|
raise Exception(f"Cannot find 'compatible' property for {device.identifier}")
|
|
device_binding = find_binding(compatible_property.value, bindings)
|
|
if device_binding is None:
|
|
raise Exception(f"Binding not found for {device.identifier} and compatible '{compatible_property.value}'")
|
|
# Filter out system properties
|
|
binding_properties = []
|
|
for property in device_binding.properties:
|
|
if property.name != "compatible":
|
|
binding_properties.append(property)
|
|
# Allocate total expected configuration arguments
|
|
result = [0] * len(binding_properties)
|
|
for index, binding_property in enumerate(binding_properties):
|
|
device_property = find_device_property(device, binding_property.name)
|
|
if device_property is None:
|
|
if binding_property.required:
|
|
raise Exception(f"device {device.identifier} doesn't have property '{binding_property.name}'")
|
|
else:
|
|
result[index] = '0'
|
|
else:
|
|
result[index] = property_to_string(device_property)
|
|
return result
|
|
|
|
def write_config(file, device: Device, bindings: list[Binding], type_name: str):
|
|
device_identifier = get_device_identifier_safe(device)
|
|
config_type = f"{type_name}_config_dt"
|
|
config_variable_name = f"{device_identifier}_config"
|
|
file.write(f"static const {config_type} {config_variable_name}" " = {\n")
|
|
config_params = resolve_parameters_from_bindings(device, bindings)
|
|
# Indent all params
|
|
for index, config_param in enumerate(config_params):
|
|
config_params[index] = f"\t{config_param}"
|
|
# Join with command and newline
|
|
if len(config_params) > 0:
|
|
config_params_joined = ",\n".join(config_params)
|
|
file.write(f"{config_params_joined}\n")
|
|
file.write("};\n\n")
|
|
|
|
def write_device_structs(file, device: Device, parent_device: Device, bindings: list[Binding], verbose: bool):
|
|
if verbose:
|
|
print(f"Writing device struct for '{device.identifier}'")
|
|
# Assemble some pre-requisites
|
|
type_name = get_device_type_name(device, bindings)
|
|
compatible_property = find_device_property(device, "compatible")
|
|
if compatible_property is None:
|
|
raise Exception(f"Cannot find 'compatible' property for {device.identifier}")
|
|
identifier = get_device_identifier_safe(device)
|
|
config_variable_name = f"{identifier}_config"
|
|
if parent_device is not None:
|
|
parent_identifier = get_device_identifier_safe(parent_device)
|
|
parent_value = f"&{parent_identifier}"
|
|
else:
|
|
parent_value = "NULL"
|
|
# Write config struct
|
|
write_config(file, device, bindings, type_name)
|
|
# Write device struct
|
|
file.write(f"static struct Device {identifier}" " = {\n")
|
|
file.write(f"\t.name = \"{device.identifier}\",\n") # Use original name
|
|
file.write(f"\t.config = &{config_variable_name},\n")
|
|
file.write(f"\t.parent = {parent_value},\n")
|
|
file.write("};\n\n")
|
|
# Child devices
|
|
for child_device in device.devices:
|
|
write_device_structs(file, child_device, device, bindings, verbose)
|
|
|
|
def write_device_init(file, device: Device, bindings: list[Binding], verbose: bool):
|
|
if verbose:
|
|
print(f"Processing device init code for '{device.identifier}'")
|
|
# Assemble some pre-requisites
|
|
compatible_property = find_device_property(device, "compatible")
|
|
if compatible_property is None:
|
|
raise Exception(f"Cannot find 'compatible' property for {device.identifier}")
|
|
# Type & instance names
|
|
identifier = get_device_identifier_safe(device)
|
|
device_variable = identifier
|
|
# Write device struct
|
|
file.write(f"\tif (init_builtin_device(&{device_variable}, \"{compatible_property.value}\") != 0) return -1;\n")
|
|
# Write children
|
|
for child_device in device.devices:
|
|
write_device_init(file, child_device, bindings, verbose)
|
|
|
|
def generate_devicetree_c(filename: str, items: list[object], bindings: list[Binding], verbose: bool):
|
|
with open(filename, "w") as file:
|
|
file.write(dedent('''\
|
|
// Default headers
|
|
#include <Tactility/Device.h>
|
|
#include <Tactility/Driver.h>
|
|
#include <Tactility/Log.h>
|
|
// DTS headers
|
|
'''))
|
|
|
|
# Write all headers first
|
|
for item in items:
|
|
if type(item) is IncludeC:
|
|
write_include(file, item, verbose)
|
|
file.write("\n")
|
|
|
|
file.write(dedent('''\
|
|
#define TAG LOG_TAG(devicetree)
|
|
|
|
static int init_builtin_device(struct Device* device, const char* compatible) {
|
|
struct Driver* driver = driver_find_compatible(compatible);
|
|
if (driver == NULL) {
|
|
LOG_E(TAG, "Can't find driver: %s", compatible);
|
|
return -1;
|
|
}
|
|
device_construct(device);
|
|
device_set_driver(device, driver);
|
|
device_add(device);
|
|
const int err = device_start(device);
|
|
if (err != 0) {
|
|
LOG_E(TAG, "Failed to start device %s with driver %s: error code %d", device->name, compatible, err);
|
|
return -1;
|
|
}
|
|
return 0;
|
|
}
|
|
|
|
'''))
|
|
|
|
# Then write all devices
|
|
for item in items:
|
|
if type(item) is Device:
|
|
write_device_structs(file, item, None, bindings, verbose)
|
|
# Init function body start
|
|
file.write("int devices_builtin_init() {\n")
|
|
# Init function body logic
|
|
for item in items:
|
|
if type(item) is Device:
|
|
write_device_init(file, item, bindings, verbose)
|
|
file.write("\treturn 0;\n")
|
|
# Init function body end
|
|
file.write("}\n")
|
|
|
|
def generate_devicetree_h(filename: str):
|
|
with open(filename, "w") as file:
|
|
file.write(dedent('''\
|
|
#pragma once
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
extern int devices_builtin_init();
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
'''))
|
|
|
|
def generate(output_path: str, items: list[object], bindings: list[Binding], verbose: bool):
|
|
if not os.path.exists(output_path):
|
|
os.makedirs(output_path)
|
|
devicetree_c_filename = os.path.join(output_path, "devicetree.c")
|
|
generate_devicetree_c(devicetree_c_filename, items, bindings, verbose)
|
|
devicetree_h_filename = os.path.join(output_path, "devicetree.h")
|
|
generate_devicetree_h(devicetree_h_filename)
|