Skip to content

Commit 5e465e7

Browse files
haatahaata
committed
Add h0020_klltrigger support
- Needed for kll-core TriggerEvents - Updated license to be dual MIT and APACHE-2.0 - Fixed some clippy warnings
1 parent 8f89ef0 commit 5e465e7

File tree

6 files changed

+282
-28
lines changed

6 files changed

+282
-28
lines changed

‎hid-io-protocol/Cargo.toml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22
name = "hid-io-protocol"
33
version = "0.1.0"
44
authors = ["Jacob Alexander <[email protected]>"]
5-
license = "MIT"
5+
license = "MIT OR Apache-2.0"
66
description = """
77
HID-IO protocol implementation for both servers and devices.
88
Devices are optimized for Cortex-M devices, but may work for other platforms.
99
"""
1010

11+
categories = ["embedded", "no-std"]
1112
homepage = "https://github.com/hid-io/hid-io-core"
1213
repository = "https://github.com/hid-io/hid-io-core"
1314
edition = "2021"
@@ -37,6 +38,7 @@ defmt-impl = ["defmt", "heapless/defmt-impl"]
3738
arraydeque = { version = "0.4", default-features = false }
3839
defmt = { version = "0.3", optional = true }
3940
heapless = { version = "0.7" }
41+
kll-core = { version = "0.1.0", git = "https://github.com/kiibohd/kiibohd-core.git" }
4042
log = { version = "0.4", default-features = false, optional = true }
4143
num_enum = { version = "0.5", default-features = false }
4244

‎hid-io-protocol/LICENSE

Lines changed: 0 additions & 21 deletions
This file was deleted.

‎hid-io-protocol/LICENSE-APACHE

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎hid-io-protocol/LICENSE-MIT

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
Permission is hereby granted, free of charge, to any
2+
person obtaining a copy of this software and associated
3+
documentation files (the "Software"), to deal in the
4+
Software without restriction, including without
5+
limitation the rights to use, copy, modify, merge,
6+
publish, distribute, sublicense, and/or sell copies of
7+
the Software, and to permit persons to whom the Software
8+
is furnished to do so, subject to the following
9+
conditions:
10+
11+
The above copyright notice and this permission notice
12+
shall be included in all copies or substantial portions
13+
of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF
16+
ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
17+
TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
18+
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT
19+
SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
20+
CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR
22+
IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
23+
DEALINGS IN THE SOFTWARE.

‎hid-io-protocol/src/commands/mod.rs

Lines changed: 77 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
/* Copyright (C) 2020-2021 by Jacob Alexander
1+
/* Copyright (C) 2020-2022 by Jacob Alexander
22
*
33
* Permission is hereby granted, free of charge, to any person obtaining a copy
44
* of this software and associated documentation files (the "Software"), to deal
@@ -438,9 +438,10 @@ pub mod h001a {
438438
}
439439

440440
/// KLL Trigger State
441-
/// TODO
442441
pub mod h0020 {
443-
pub struct Cmd {}
442+
pub struct Cmd {
443+
pub event: kll_core::TriggerEvent,
444+
}
444445
pub struct Ack {}
445446
pub struct Nak {}
446447
}
@@ -1512,6 +1513,79 @@ pub trait Commands<const H: usize, const HSUB1: usize, const HSUB4: usize, const
15121513
}
15131514
}
15141515

1516+
fn h0020_klltrigger(&mut self, data: h0020::Cmd, na: bool) -> Result<(), CommandError> {
1517+
// Create appropriately sized buffer
1518+
let mut buf = HidIoPacketBuffer {
1519+
// KllState id
1520+
id: HidIoCommandId::KllState,
1521+
// Detect max size
1522+
max_len: self.default_packet_chunk(),
1523+
// Use defaults for other fields
1524+
..Default::default()
1525+
};
1526+
1527+
// Set NA (no-ack)
1528+
if na {
1529+
buf.ptype = HidIoPacketType::NaData;
1530+
}
1531+
1532+
// Build payload
1533+
if !buf.append_payload(unsafe { data.event.bytes() }) {
1534+
return Err(CommandError::DataVecTooSmall);
1535+
}
1536+
buf.done = true;
1537+
1538+
self.tx_packetbuffer_send(&mut buf)
1539+
}
1540+
fn h0020_klltrigger_cmd(&mut self, _data: h0020::Cmd) -> Result<h0020::Ack, h0020::Nak> {
1541+
Err(h0020::Nak {})
1542+
}
1543+
fn h0020_klltrigger_nacmd(&mut self, _data: h0020::Cmd) -> Result<(), CommandError> {
1544+
Err(CommandError::IdNotImplemented(
1545+
HidIoCommandId::UnicodeState,
1546+
HidIoPacketType::NaData,
1547+
))
1548+
}
1549+
fn h0020_klltrigger_ack(&mut self, _data: h0020::Ack) -> Result<(), CommandError> {
1550+
Err(CommandError::IdNotImplemented(
1551+
HidIoCommandId::UnicodeState,
1552+
HidIoPacketType::Ack,
1553+
))
1554+
}
1555+
fn h0020_klltrigger_nak(&mut self, _data: h0020::Nak) -> Result<(), CommandError> {
1556+
Err(CommandError::IdNotImplemented(
1557+
HidIoCommandId::UnicodeState,
1558+
HidIoPacketType::Nak,
1559+
))
1560+
}
1561+
fn h0020_klltrigger_handler(&mut self, buf: HidIoPacketBuffer<H>) -> Result<(), CommandError> {
1562+
// Handle packet type
1563+
match buf.ptype {
1564+
HidIoPacketType::Data => {
1565+
// Copy data into struct
1566+
let cmd = h0020::Cmd {
1567+
event: unsafe { kll_core::TriggerEvent::from_bytes(&buf.data) },
1568+
};
1569+
1570+
match self.h0020_klltrigger_cmd(cmd) {
1571+
Ok(_ack) => self.empty_ack(buf.id),
1572+
Err(_nak) => self.empty_nak(buf.id),
1573+
}
1574+
}
1575+
HidIoPacketType::NaData => {
1576+
// Copy data into struct
1577+
let cmd = h0020::Cmd {
1578+
event: unsafe { kll_core::TriggerEvent::from_bytes(&buf.data) },
1579+
};
1580+
1581+
self.h0020_klltrigger_nacmd(cmd)
1582+
}
1583+
HidIoPacketType::Ack => self.h0020_klltrigger_ack(h0020::Ack {}),
1584+
HidIoPacketType::Nak => self.h0020_klltrigger_nak(h0020::Nak {}),
1585+
_ => Ok(()),
1586+
}
1587+
}
1588+
15151589
fn h0031_terminalcmd(&mut self, data: h0031::Cmd<H>, na: bool) -> Result<(), CommandError> {
15161590
// Create appropriately sized buffer
15171591
let mut buf = HidIoPacketBuffer {

‎hid-io-protocol/src/lib.rs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -521,7 +521,7 @@ impl<const H: usize> HidIoPacketBuffer<H> {
521521
}
522522

523523
let hdr_len = self.hdr_len();
524-
let data_len = (&self.data).len() as u32;
524+
let data_len = self.data.len() as u32;
525525
let payload_len = self.payload_len();
526526

527527
let fullpackets = (data_len / payload_len) * (payload_len + u32::from(hdr_len));
@@ -708,7 +708,7 @@ impl<const H: usize> HidIoPacketBuffer<H> {
708708
let payload_len = self.payload_len();
709709

710710
// Data length
711-
let data_len = (&self.data).len() as u32;
711+
let data_len = self.data.len() as u32;
712712

713713
// Determine if a continued packet construct
714714
let mut cont: bool = data_len > payload_len;
@@ -790,7 +790,7 @@ impl<const H: usize> HidIoPacketBuffer<H> {
790790
}
791791

792792
// Determine how much payload is left
793-
let mut payload_left = (&self.data).len() as u32 - payload_len;
793+
let mut payload_left = self.data.len() as u32 - payload_len;
794794
let mut last_slice_index = payload_len as usize;
795795

796796
// --- Additional Packets ---

0 commit comments

Comments
 (0)