gitbot/qmk_firmware
0
0
Fork 0
mirror of https://github.com/qmk/qmk_firmware.git synced 2025-04-04 12:55:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

Stub out nested routes

Browse Source
This commit is contained in:
zvecr 2022-09-26 01:09:15 +01:00
parent 017ee1ec30
commit 76a45a4e24
6 changed files with 50 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
data/templates/xap/client/python/routes.py.j2
View File

@ -9,6 +9,11 @@ class XAPRoutes():
# {{route.define}}
{%- for subid, subroute in route.routes | dictsort %}
{{route.define}}_{{subroute.define}} = b'\x{{ '%02d' % id|int(base=16) }}\x{{ '%02d' % subid|int(base=16) }}'
{%- if subroute.routes %}
{%- for subsubid, subsubroute in subroute.routes | dictsort %}
{{route.define}}_{{subroute.define}}_{{subsubroute.define}} = b'\x{{ '%02d' % id|int(base=16) }}\x{{ '%02d' % subid|int(base=16) }}\x{{ '%02d' % subsubid|int(base=16) }}'
{%- endfor %}
{%- endif %}
{%- endfor %}
{%- endif %}
{%- endfor %}

8
data/templates/xap/docs/route_request.md.j2
View File

@ -1,8 +1,8 @@
{%- if subroute.request_type == 'struct' -%}
{%- if route.request_type == 'struct' -%}
__Request:__
{%- for member in subroute.request_struct_members -%}
{%- for member in route.request_struct_members -%}
<br>{{ "&nbsp;"|safe*4 }}* {{ member.name }}: `{{ member.type }}`
{%- endfor -%}
{%- elif subroute.request_type -%}
__Request:__ `{{ subroute.request_type }}`
{%- elif route.request_type -%}
__Request:__ `{{ route.request_type }}`
{%- endif -%}

8
data/templates/xap/docs/route_response.md.j2
View File

@ -1,8 +1,8 @@
{%- if subroute.return_type == 'struct' -%}
{%- if route.return_type == 'struct' -%}
__Response:__
{%- for member in subroute.return_struct_members -%}
{%- for member in route.return_struct_members -%}
<br>{{ "&nbsp;"|safe*4 }}* {{ member.name }}: `{{ member.type }}`
{%- endfor -%}
{%- elif subroute.return_type -%}
__Response:__ `{{ subroute.return_type }}`
{%- elif route.return_type -%}
__Response:__ `{{ route.return_type }}`
{%- endif -%}

22
data/templates/xap/docs/routes.md.j2
View File

@ -6,7 +6,29 @@
| Name | Route | Tags | Payloads | Description |
| -- | -- | -- | -- | -- |
{%- for subid, subroute in route.routes | dictsort %}
{%- if not subroute.routes %}
{%- with route=subroute %}
| {{ subroute.name }} | `{{ id }} {{ subid }}` | {% if 'secure' == subroute.permissions %}__Secure__{% endif %} | {%- include 'route_request.md.j2' -%}{%- if subroute.return_type and subroute.request_type -%}<br><br>{% endif %}{%- include 'route_response.md.j2' -%} | {{ subroute.description.replace('\n', '<br>') }}|
{%- endwith %}
{%- endif %}
{%- endfor %}
{%- for subid, subroute in route.routes | dictsort %}
{%- if subroute.routes %}
#### {{ subroute.name }} - `{{ id }} {{ subid }}`
{{ subroute.description }}
| Name | Route | Tags | Payloads | Description |
| -- | -- | -- | -- | -- |
{%- for subsubid, subsubroute in subroute.routes | dictsort %}
{%- if not subsubroute.routes %}
{%- with route=subsubroute %}
| {{ subsubroute.name }} | `{{ id }} {{ subid }} {{ subsubid }}` | {% if 'secure' == subsubroute.permissions %}__Secure__{% endif %} | {%- include 'route_request.md.j2' -%}{%- if subsubroute.return_type and subsubroute.request_type -%}<br><br>{% endif %}{%- include 'route_response.md.j2' -%} | {{ subsubroute.description.replace('\n', '<br>') }}|
{%- endwith %}
{%- endif %}
{%- endfor %}
{%- endif %}
{%- endfor %}
{% endif %}
{%- endfor %}

9
lib/python/qmk/xap/gen_firmware/inline_generator.py
View File

@ -53,6 +53,8 @@ def _get_route_type(container):
return 'XAP_CONST_MEM'
elif container['return_type'] == 'u32':
return 'XAP_CONST_MEM'
elif container['return_type'] == 'u64':
return 'XAP_CONST_MEM'
elif container['return_type'] == 'struct':
return 'XAP_CONST_MEM'
elif container['return_type'] == 'string':
@ -98,6 +100,11 @@ def _append_routing_table_declaration(lines, container, container_id, route_stac
lines.append('')
lines.append(f'static const uint32_t {route_name}_data PROGMEM = {constant};')
elif container['return_type'] == 'u64':
constant = container['return_constant']
lines.append('')
lines.append(f'static const uint64_t {route_name}_data PROGMEM = {constant};')
elif container['return_type'] == 'struct':
lines.append('')
lines.append(f'static const {route_name}_t {route_name}_data PROGMEM = {{')
@ -196,6 +203,8 @@ def _append_routing_table_entry(lines, container, container_id, route_stack):
_append_routing_table_entry_const_data(lines, container, container_id, route_stack)
elif container['return_type'] == 'u32':
_append_routing_table_entry_const_data(lines, container, container_id, route_stack)
elif container['return_type'] == 'u64':
_append_routing_table_entry_const_data(lines, container, container_id, route_stack)
elif container['return_type'] == 'struct':
_append_routing_table_entry_const_data(lines, container, container_id, route_stack)
elif container['return_type'] == 'string':

8
lib/python/xap_client/device.py
View File

@ -147,8 +147,12 @@ class XAPDevice(XAPDeviceBase):
XAPRouteError: Access to invalid route attempted
"""
# TODO: Remove assumption that capability is always xx01
(sub, rt) = route
cap = bytes([sub, 1])
(remain, sub, rt) = (route[:-2], route[-2], route[-1])
cap = remain + bytes([sub, 1])
# recurse for nested routes
if remain:
self._ensure_route(remain + bytes([sub]))
if self.subsystems() & (1 << sub) == 0:
raise XAPRouteError("subsystem not available")