README.md 4.24 KB
Newer Older
1
2
3
fwupd
=====

4
This project aims to make updating firmware on Linux automatic, safe and reliable.
5
6

Additional information is available at the website: http://www.fwupd.org
7
8
9
10

DFU Support
-----------

11
DFU support is supported directly by this project with the embedded libdfu
12
library.
13

14
ColorHug Support
15
----------------
16

Mario Limonciello's avatar
Mario Limonciello committed
17
For colorhug support you need to install colord 1.2.12 or later.
18
* source:		https://github.com/hughsie/colord
Mario Limonciello's avatar
Mario Limonciello committed
19
* rpms:			http://people.freedesktop.org/~hughsient/fedora/
20
21
* debs (Debian):	https://tracker.debian.org/pkg/fwupd
* debs (Ubuntu):	https://launchpad.net/ubuntu/+source/fwupd
22

Jonathan's avatar
Jonathan committed
23
If you don't want or need this functionality you can use the
24
`--disable-colorhug` option.
25

26
UEFI Support
27
------------
28

Mario Limonciello's avatar
Mario Limonciello committed
29
For UEFI capsule support, you need to install fwupdate 0.5 or later.
30
* source:		https://github.com/rhinstaller/fwupdate
Mario Limonciello's avatar
Mario Limonciello committed
31
* rpms:			https://pjones.fedorapeople.org/fwupdate/
32
* debs (Debian):	https://tracker.debian.org/pkg/fwupdate
Mario Limonciello's avatar
Mario Limonciello committed
33
* debs (Ubuntu):	https://launchpad.net/ubuntu/+source/fwupdate
34

35
If you don't want or need this functionality you can use the
36
37
38
39
40
41
42
`--disable-uefi` option.

UEFI Unlock Support
-------------------

On some Dell systems it's possible to turn on and off UEFI capsule
support from within the BIOS.  This functionality can also be adjusted
43
from within the OS by fwupd. This requires using fwupdate 0.6 or later
44
45
46
47
48
and compiling it with libsmbios support.

When fwupd and fwupdate have been compiled with this support you will
be able to enable UEFI support on the device by using the `unlock` command.

49
50
51
52
Dell Support
----------------

This allows installing Dell capsules that are not part of the ESRT table.
53
54
Information on special features enabled by this provider are available here:
https://github.com/hughsie/fwupd/blob/master/docs/dell-provider.md
55
56
57
58
59
60
61
62

For Dell support you will need libsmbios_c version 2.3.0 or later and
efivar.
* source:		http://linux.dell.com/cgi-bin/cgit.cgi/libsmbios.git/
* rpms:		https://apps.fedoraproject.org/packages/libsmbios
* debs (Debian):	http://tracker.debian.org/pkg/libsmbios
* debs (Ubuntu):	http://launchpad.net/ubuntu/+source/libsmbios

63
64
65
If you don't want or need this functionality you can use the
`--disable-dell` option.

66
67
68
Raspberry Pi support
--------------------

Mario Limonciello's avatar
Mario Limonciello committed
69
A provider is available that can flash the boot firmware on the Raspberry Pi.
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

Adding a new provider
---------------------

An extensible architecture allows for providing new Provider types (for reading
and writing different firmware) as well as for plugins that can extend existing
firmware providers to quirk their behavior.

If you have a firmware specification and would like to see support
in this project, please file an issue and share the spec.  Patches are also
welcome.

LVFS
----
This project is configured by default to download firmware from the [Linux Vendor
Firmware Service (LVFS)] (https://secure-lvfs.rhcloud.com/lvfs/).
86

87
88
This service is available to all OEMs and firmware creators who would like to make
their firmware available to Linux users.
89
90
91
92
93

Basic usage flow (command line)
------------------------------

If you have a device with firmware supported by fwupd, this is how you will check
94
for updates and apply them using fwupd's command line tools.
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

`fwupdmgr get-devices`

This will display all devices detected by fwupd.

`fwupdmgr refresh`

This will download the latest metadata from LVFS.

`fwupdmgr get-updates`

If updates are available for any devices on the system, they'll be displayed.

`fwupdmgr update`

This will download and apply all updates for your system.

* Updates that can be applied live *(Online updates)* will be done immediately.
* Updates that require a reboot *(Offline updates)* will be staged for the next reboot.

Other frontends
-------------------

118
Currently [GNOME Software] (https://wiki.gnome.org/Apps/Software) is the only graphical
119
frontend available.  When compiled with firmware support, it will check for updates
120
periodically and automatically download firmware in the background.
121
122
123
124

After the firmware has been downloaded a popup will be displayed in Gnome Software
to perform the update.

125
126
127
On Dell IoT gateways, [Wyse Cloud Client Manager (CCM)] (http://www.dell.com/us/business/p/wyse-cloud-client-manager/pd)
has been built with fwupd support.
The remote administration interface can be used to download and deploy
128
firmware updates.