ahoneybun/qmk_firmware
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add types codegen

Browse source
This commit is contained in:
zvecr 2022-03-31 22:34:01 +01:00
parent ffcdfc6c03
commit 53052228df
2 changed files with 94 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

68
data/xap/xap_0.0.1.hjson
View file

@ -101,10 +101,6 @@
'''
A high-level area of functionality within XAP.
'''
ID:
'''
A single octet / 8-bit byte.
'''
Route:
'''
A sequence of _IDs_ describing the route to invoke a _handler_.
@ -113,24 +109,72 @@
'''
A piece of code that is executed when a specific _route_ is received.
'''
Token:
'''
A `u16` associated with a specific request as well as its corresponding response.
'''
Response:
'''
The data sent back to the host during execution of a _handler_.
'''
"Response Flags":
'''
An `u8` containing the status of the request.
'''
Payload:
'''
Any received data appended to the _route_, which gets delivered to the _handler_ when received.
'''
}
types: {
identifier: {
name: ID
description: Subsystem/Route ID
type: u8
}
response_flags: {
name: Response Flags
description: Contains the status of the request
type: u8
}
token: {
name: Token
description: ID associated with a specific request as well as its corresponding response
type: u16
}
request_header: {
name: Request Header
description: asdf
type: struct
struct_members: [
{
type: token
name: token
},
{
type: u8
name: length
}
]
}
response_header: {
name: Response Header
description: asdf
type: struct
struct_members: [
{
type: token
name: token
},
{
type: response_flags
name: flags
},
{
type: u8
name: length
}
]
}
}
response_flags: {
define_prefix: XAP_RESPONSE_FLAG
bits: {