-
Notifications
You must be signed in to change notification settings - Fork 411
/
fu-quirks.h
406 lines (399 loc) · 8.26 KB
/
fu-quirks.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
/*
* Copyright (C) 2016 Mario Limonciello <mario.limonciello@dell.com>
* Copyright (C) 2017 Richard Hughes <richard@hughsie.com>
*
* SPDX-License-Identifier: LGPL-2.1+
*/
#pragma once
#include <glib-object.h>
#define FU_TYPE_QUIRKS (fu_quirks_get_type())
G_DECLARE_FINAL_TYPE(FuQuirks, fu_quirks, FU, QUIRKS, GObject)
/**
* FuQuirksLoadFlags:
* @FU_QUIRKS_LOAD_FLAG_NONE: No flags set
* @FU_QUIRKS_LOAD_FLAG_READONLY_FS: Ignore readonly filesystem errors
* @FU_QUIRKS_LOAD_FLAG_NO_CACHE: Do not save to a persistent cache
* @FU_QUIRKS_LOAD_FLAG_NO_VERIFY: Do not check the key files for errors
*
* The flags to use when loading quirks.
**/
typedef enum {
FU_QUIRKS_LOAD_FLAG_NONE = 0,
FU_QUIRKS_LOAD_FLAG_READONLY_FS = 1 << 0,
FU_QUIRKS_LOAD_FLAG_NO_CACHE = 1 << 1,
FU_QUIRKS_LOAD_FLAG_NO_VERIFY = 1 << 2,
/*< private >*/
FU_QUIRKS_LOAD_FLAG_LAST
} FuQuirksLoadFlags;
/**
* FuQuirksIter:
* @self: a #FuQuirks
* @key: a key
* @value: a value
* @user_data: (closure): user data
*
* The quirks iteration callback.
*/
typedef void (*FuQuirksIter)(FuQuirks *self,
const gchar *key,
const gchar *value,
gpointer user_data);
FuQuirks *
fu_quirks_new(void);
gboolean
fu_quirks_load(FuQuirks *self,
FuQuirksLoadFlags load_flags,
GError **error) G_GNUC_WARN_UNUSED_RESULT;
const gchar *
fu_quirks_lookup_by_id(FuQuirks *self, const gchar *guid, const gchar *key);
gboolean
fu_quirks_lookup_by_id_iter(FuQuirks *self,
const gchar *guid,
FuQuirksIter iter_cb,
gpointer user_data);
void
fu_quirks_add_possible_key(FuQuirks *self, const gchar *possible_key);
/**
* FU_QUIRKS_PLUGIN:
*
* The quirk key for the plugin name.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_PLUGIN "Plugin"
/**
* FU_QUIRKS_FLAGS:
*
* The quirk key for the public flags.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_FLAGS "Flags"
/**
* FU_QUIRKS_SUMMARY:
*
* The quirk key for the summary.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_SUMMARY "Summary"
/**
* FU_QUIRKS_ICON:
*
* The quirk key for the icon.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_ICON "Icon"
/**
* FU_QUIRKS_NAME:
*
* The quirk key for the name.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_NAME "Name"
/**
* FU_QUIRKS_BRANCH:
*
* The quirk key for the firmware branch.
*
* Since: 1.5.0
**/
#define FU_QUIRKS_BRANCH "Branch"
/**
* FU_QUIRKS_GUID:
*
* The quirk key for the GUID.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_GUID "Guid"
/**
* FU_QUIRKS_COUNTERPART_GUID:
*
* The quirk key for the counterpart GUID.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_COUNTERPART_GUID "CounterpartGuid"
/**
* FU_QUIRKS_PARENT_GUID:
*
* The quirk key for the parent GUID.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_PARENT_GUID "ParentGuid"
/**
* FU_QUIRKS_PROXY_GUID:
*
* The quirk key for the proxy GUID.
*
* Since: 1.4.1
**/
#define FU_QUIRKS_PROXY_GUID "ProxyGuid"
/**
* FU_QUIRKS_CHILDREN:
*
* The quirk key for the children. This should contain the custom GType.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_CHILDREN "Children"
/**
* FU_QUIRKS_VERSION:
*
* The quirk key for the version.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_VERSION "Version"
/**
* FU_QUIRKS_VENDOR:
*
* The quirk key for the vendor name.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_VENDOR "Vendor"
/**
* FU_QUIRKS_VENDOR_ID:
*
* The quirk key for the vendor ID.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_VENDOR_ID "VendorId"
/**
* FU_QUIRKS_FIRMWARE_SIZE_MIN:
*
* The quirk key for the minimum firmware size in bytes.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_FIRMWARE_SIZE_MIN "FirmwareSizeMin"
/**
* FU_QUIRKS_FIRMWARE_SIZE_MAX:
*
* The quirk key for the maximum firmware size in bytes.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_FIRMWARE_SIZE_MAX "FirmwareSizeMax"
/**
* FU_QUIRKS_FIRMWARE_SIZE:
*
* The quirk key for the exact required firmware size in bytes.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_FIRMWARE_SIZE "FirmwareSize"
/**
* FU_QUIRKS_INSTALL_DURATION:
*
* The quirk key for the install duration in seconds.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_INSTALL_DURATION "InstallDuration"
/**
* FU_QUIRKS_VERSION_FORMAT:
*
* The quirk key for the version format, e.g. `quad`.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_VERSION_FORMAT "VersionFormat"
/**
* FU_QUIRKS_GTYPE:
*
* The quirk key for the custom GType.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_GTYPE "GType"
/**
* FU_QUIRKS_FIRMWARE_GTYPE:
*
* The quirk key for the custom firmware GType.
*
* Since: 1.7.2
**/
#define FU_QUIRKS_FIRMWARE_GTYPE "FirmwareGType"
/**
* FU_QUIRKS_PROTOCOL:
*
* The quirk key for the protocol, e.g. `org.usb.dfu`.
*
* Since: 1.3.7
**/
#define FU_QUIRKS_PROTOCOL "Protocol"
/**
* FU_QUIRKS_UPDATE_MESSAGE:
*
* The quirk key for the update message shown after the transaction has completed.
*
* Since: 1.4.0
**/
#define FU_QUIRKS_UPDATE_MESSAGE "UpdateMessage"
/**
* FU_QUIRKS_UPDATE_IMAGE:
*
* The quirk key for the update image shown before the update is performed.
*
* Since: 1.5.0
**/
#define FU_QUIRKS_UPDATE_IMAGE "UpdateImage"
/**
* FU_QUIRKS_PRIORITY:
*
* The quirk key for the device priority.
*
* Since: 1.4.1
**/
#define FU_QUIRKS_PRIORITY "Priority"
/**
* FU_QUIRKS_BATTERY_THRESHOLD:
*
* The quirk key for the battery threshold in percent.
*
* Since: 1.6.0
**/
#define FU_QUIRKS_BATTERY_THRESHOLD "BatteryThreshold"
/**
* FU_QUIRKS_REMOVE_DELAY:
*
* The quirk key for the device removal delay in milliseconds.
*
* Since: 1.5.0
**/
#define FU_QUIRKS_REMOVE_DELAY "RemoveDelay"
/**
* FU_QUIRKS_ACQUIESCE_DELAY:
*
* The quirk key for the device removal delay in milliseconds.
*
* Since: 1.8.3
**/
#define FU_QUIRKS_ACQUIESCE_DELAY "AcquiesceDelay"
/**
* FU_QUIRKS_INHIBIT:
*
* The quirk key to inhibit the UPDATABLE flag and to set an update error.
*
* Since: 1.6.2
**/
#define FU_QUIRKS_INHIBIT "Inhibit"
/**
* FU_QUIRKS_ISSUE:
*
* The quirk key to add security issues affecting a specific device.
*
* Since: 1.7.6
**/
#define FU_QUIRKS_ISSUE "Issue"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_READ_ID
*
* The quirk key to set the CFI read ID command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_READ_ID "CfiDeviceCmdReadId"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_READ_ID_SZ
*
* The quirk key to set the CFI read ID size.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_READ_ID_SZ "CfiDeviceCmdReadIdSz"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_CHIP_ERASE
*
* The quirk key to set the CFI chip erase command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_CHIP_ERASE "CfiDeviceCmdChipErase"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_BLOCK_ERASE
*
* The quirk key to set the CFI block erase command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_BLOCK_ERASE "CfiDeviceCmdBlockErase"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_SECTOR_ERASE
*
* The quirk key to set the CFI sector erase command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_SECTOR_ERASE "CfiDeviceCmdSectorErase"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_WRITE_STATUS
*
* The quirk key to set the CFI write status command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_WRITE_STATUS "CfiDeviceCmdWriteStatus"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_PAGE_PROG
*
* The quirk key to set the CFI page program command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_PAGE_PROG "CfiDeviceCmdPageProg"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_READ_DATA
*
* The quirk key to set the CFI read data command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_READ_DATA "CfiDeviceCmdReadData"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_READ_STATUS
*
* The quirk key to set the CFI read status command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_READ_STATUS "CfiDeviceCmdReadStatus"
/**
* FU_QUIRKS_CFI_DEVICE_CMD_WRITE_EN
*
* The quirk key to set the CFI write en command.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_CMD_WRITE_EN "CfiDeviceCmdWriteEn"
/**
* FU_QUIRKS_CFI_DEVICE_PAGE_SIZE
*
* The quirk key to set the CFI page size.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_PAGE_SIZE "CfiDevicePageSize"
/**
* FU_QUIRKS_CFI_DEVICE_SECTOR_SIZE
*
* The quirk key to set the CFI sector size.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_SECTOR_SIZE "CfiDeviceSectorSize"
/**
* FU_QUIRKS_CFI_DEVICE_BLOCK_SIZE
*
* The quirk key to set the CFI block size.
*
* Since: 1.8.2
**/
#define FU_QUIRKS_CFI_DEVICE_BLOCK_SIZE "CfiDeviceBlockSize"