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
|
---
title: Plugin: {{Vendor}} {{Example}}
---
## Introduction
The {{Example}} is a bla bla bla.
## Firmware Format
The daemon will decompress the cabinet archive and extract a firmware blob in
a packed binary file format.
This plugin supports the following protocol ID:
* `com.{{vendor}}.{{example}}`
## GUID Generation
{% if Parent == 'Usb' -%}
These devices use the standard USB DeviceInstanceId values, e.g.
* `USB\ID_XXX`
* `USB\VID_273F&PID_1001`
{%- else -%}
These devices use the standard TODO DeviceInstanceId values, e.g.
* `TODO\VID_XXX`
{%- endif %}
## Update Behavior
The device is updated by bla bla bla.
## Vendor ID Security
{% if Parent in ['Usb', 'Hid'] -%}
The vendor ID is set from the USB vendor, in this instance set to `USB:0x273F`
{%- else -%}
The vendor ID is set from the TODO vendor, in this instance set to `TODO:0x273F`
{%- endif %}
## Quirk Use
This plugin uses the following plugin-specific quirks:
### {{VendorExample}}StartAddr
The bla bla bla.
Since: 1.8.TODO
## External Interface Access
{% if Parent in ['Usb', 'Hid'] -%}
This plugin requires read/write access to `/dev/bus/usb`.
{%- else -%}
This plugin requires read/write access to `TODO`.
{%- endif %}
## Version Considerations
This plugin has been available since fwupd version `SET_VERSION_HERE`.
## Owners
Anyone can submit a pull request to modify this plugin, but the following people should be
consulted before making major or functional changes:
* {{Vendor}}: @github-username
|
