1 /* -----------------------------------------------------------------------------
2 * Copyright (c) 2011 Ozmo Inc
3 * Released under the GNU General Public License Version 2 (GPLv2).
4 * -----------------------------------------------------------------------------
9 #define PACKED __packed
11 #define OZ_ETHERTYPE 0x892e
15 #define OZ_STATUS_SUCCESS 0
16 #define OZ_STATUS_INVALID_PARAM 1
17 #define OZ_STATUS_TOO_MANY_PDS 2
18 #define OZ_STATUS_NOT_ALLOWED 4
19 #define OZ_STATUS_SESSION_MISMATCH 5
20 #define OZ_STATUS_SESSION_TEARDOWN 6
22 /* This is the generic element header.
23 Every element starts with this.
30 #define oz_next_elt(__elt) \
31 (struct oz_elt *)((u8 *)((__elt) + 1) + (__elt)->length)
33 /* Protocol element IDs.
35 #define OZ_ELT_CONNECT_REQ 0x06
36 #define OZ_ELT_CONNECT_RSP 0x07
37 #define OZ_ELT_DISCONNECT 0x08
38 #define OZ_ELT_UPDATE_PARAM_REQ 0x11
39 #define OZ_ELT_FAREWELL_REQ 0x12
40 #define OZ_ELT_APP_DATA 0x31
42 /* This is the Ozmo header which is the first Ozmo specific part
43 * of a frame and comes after the MAC header.
51 #define OZ_PROTOCOL_VERSION 0x1
52 /* Bits in the control field. */
53 #define OZ_VERSION_MASK 0xc
54 #define OZ_VERSION_SHIFT 2
56 #define OZ_F_ISOC 0x20
57 #define OZ_F_MORE_DATA 0x40
58 #define OZ_F_ACK_REQUESTED 0x80
60 #define oz_get_prot_ver(__x) (((__x) & OZ_VERSION_MASK) >> OZ_VERSION_SHIFT)
62 /* Used to select the bits of packet number to put in the last_pkt_num.
64 #define OZ_LAST_PN_MASK 0x00ff
66 #define OZ_LAST_PN_HALF_CYCLE 127
68 #define OZ_LATENCY_MASK 0xc0
69 #define OZ_ONE_MS_LATENCY 0x40
70 #define OZ_TEN_MS_LATENCY 0x80
72 /* Connect request data structure.
74 struct oz_elt_connect_req {
91 #define OZ_MODE_POLLED 0x0
92 #define OZ_MODE_TRIGGERED 0x1
93 #define OZ_MODE_MASK 0xf
94 #define OZ_F_ISOC_NO_ELTS 0x40
95 #define OZ_F_ISOC_ANYTIME 0x80
96 #define OZ_NO_ELTS_ANYTIME 0xc0
100 #define OZ_KALIVE_TYPE_MASK 0xc0
101 #define OZ_KALIVE_VALUE_MASK 0x3f
102 #define OZ_KALIVE_SPECIAL 0x00
103 #define OZ_KALIVE_SECS 0x40
104 #define OZ_KALIVE_MINS 0x80
105 #define OZ_KALIVE_HOURS 0xc0
107 /* Connect response data structure.
109 struct oz_elt_connect_rsp {
118 struct oz_elt_farewell {
124 struct oz_elt_update_param {
132 /* Header common to all application elements.
139 /* Values for app_id.
141 #define OZ_APPID_USB 0x1
142 #define OZ_APPID_SERIAL 0x4
143 #define OZ_APPID_MAX OZ_APPID_SERIAL
144 #define OZ_NB_APPS (OZ_APPID_MAX+1)
146 /* USB header common to all elements for the USB application.
147 * This header extends the oz_app_hdr and comes directly after
148 * the element header in a USB application.
158 /* USB requests element subtypes (type field of hs_usb_hdr).
160 #define OZ_GET_DESC_REQ 1
161 #define OZ_GET_DESC_RSP 2
162 #define OZ_SET_CONFIG_REQ 3
163 #define OZ_SET_CONFIG_RSP 4
164 #define OZ_SET_INTERFACE_REQ 5
165 #define OZ_SET_INTERFACE_RSP 6
166 #define OZ_VENDOR_CLASS_REQ 7
167 #define OZ_VENDOR_CLASS_RSP 8
168 #define OZ_GET_STATUS_REQ 9
169 #define OZ_GET_STATUS_RSP 10
170 #define OZ_CLEAR_FEATURE_REQ 11
171 #define OZ_CLEAR_FEATURE_RSP 12
172 #define OZ_SET_FEATURE_REQ 13
173 #define OZ_SET_FEATURE_RSP 14
174 #define OZ_GET_CONFIGURATION_REQ 15
175 #define OZ_GET_CONFIGURATION_RSP 16
176 #define OZ_GET_INTERFACE_REQ 17
177 #define OZ_GET_INTERFACE_RSP 18
178 #define OZ_SYNCH_FRAME_REQ 19
179 #define OZ_SYNCH_FRAME_RSP 20
180 #define OZ_USB_ENDPOINT_DATA 23
182 #define OZ_REQD_D2H 0x80
184 struct oz_get_desc_req {
197 /* Values for desc_type field.
199 #define OZ_DESC_DEVICE 0x01
200 #define OZ_DESC_CONFIG 0x02
201 #define OZ_DESC_STRING 0x03
203 /* Values for req_type field.
205 #define OZ_RECP_MASK 0x1F
206 #define OZ_RECP_DEVICE 0x00
207 #define OZ_RECP_INTERFACE 0x01
208 #define OZ_RECP_ENDPOINT 0x02
210 #define OZ_REQT_MASK 0x60
211 #define OZ_REQT_STD 0x00
212 #define OZ_REQT_CLASS 0x20
213 #define OZ_REQT_VENDOR 0x40
215 struct oz_get_desc_rsp {
226 struct oz_feature_req {
236 struct oz_feature_rsp {
244 struct oz_set_config_req {
252 struct oz_set_config_rsp {
260 struct oz_set_interface_req {
269 struct oz_set_interface_rsp {
277 struct oz_get_interface_req {
285 struct oz_get_interface_rsp {
294 struct oz_vendor_class_req {
306 struct oz_vendor_class_rsp {
323 struct oz_isoc_fixed {
334 struct oz_multiple_fixed {
344 struct oz_fragmented {
355 /* Note: the following does not get packaged in an element in the same way
356 * that other data formats are packaged. Instead the data is put in a frame
357 * directly after the oz_header and is the only permitted data in such a
358 * frame. The length of the data is directly determined from the frame size.
360 struct oz_isoc_large {
367 #define OZ_DATA_F_TYPE_MASK 0xF
368 #define OZ_DATA_F_MULTIPLE_FIXED 0x1
369 #define OZ_DATA_F_MULTIPLE_VAR 0x2
370 #define OZ_DATA_F_ISOC_FIXED 0x3
371 #define OZ_DATA_F_ISOC_VAR 0x4
372 #define OZ_DATA_F_FRAGMENTED 0x5
373 #define OZ_DATA_F_ISOC_LARGE 0x7
375 #endif /* _OZPROTOCOL_H */