| .. | .. |
|---|
| 15 | 15 | to the fw_cfg device can be found in "docs/specs/fw_cfg.txt" |
|---|
| 16 | 16 | in the QEMU source tree. |
|---|
| 17 | 17 | |
|---|
| 18 | | - === SysFS fw_cfg Interface === |
|---|
| 18 | + **SysFS fw_cfg Interface** |
|---|
| 19 | 19 | |
|---|
| 20 | 20 | The fw_cfg sysfs interface described in this document is only |
|---|
| 21 | 21 | intended to display discoverable blobs (i.e., those registered |
|---|
| .. | .. |
|---|
| 31 | 31 | |
|---|
| 32 | 32 | /sys/firmware/qemu_fw_cfg/rev |
|---|
| 33 | 33 | |
|---|
| 34 | | - --- Discoverable fw_cfg blobs by selector key --- |
|---|
| 34 | + **Discoverable fw_cfg blobs by selector key** |
|---|
| 35 | 35 | |
|---|
| 36 | 36 | All discoverable blobs listed in the fw_cfg file directory are |
|---|
| 37 | 37 | displayed as entries named after their unique selector key |
|---|
| .. | .. |
|---|
| 45 | 45 | Each such fw_cfg sysfs entry has the following values exported |
|---|
| 46 | 46 | as attributes: |
|---|
| 47 | 47 | |
|---|
| 48 | | - name : The 56-byte nul-terminated ASCII string used as the |
|---|
| 48 | + ==== ==================================================== |
|---|
| 49 | + name The 56-byte nul-terminated ASCII string used as the |
|---|
| 49 | 50 | blob's 'file name' in the fw_cfg directory. |
|---|
| 50 | | - size : The length of the blob, as given in the fw_cfg |
|---|
| 51 | + size The length of the blob, as given in the fw_cfg |
|---|
| 51 | 52 | directory. |
|---|
| 52 | | - key : The value of the blob's selector key as given in the |
|---|
| 53 | + key The value of the blob's selector key as given in the |
|---|
| 53 | 54 | fw_cfg directory. This value is the same as used in |
|---|
| 54 | 55 | the parent directory name. |
|---|
| 55 | | - raw : The raw bytes of the blob, obtained by selecting the |
|---|
| 56 | + raw The raw bytes of the blob, obtained by selecting the |
|---|
| 56 | 57 | entry via the control register, and reading a number |
|---|
| 57 | 58 | of bytes equal to the blob size from the data |
|---|
| 58 | 59 | register. |
|---|
| 60 | + ==== ==================================================== |
|---|
| 59 | 61 | |
|---|
| 60 | | - --- Listing fw_cfg blobs by file name --- |
|---|
| 62 | + **Listing fw_cfg blobs by file name** |
|---|
| 61 | 63 | |
|---|
| 62 | 64 | While the fw_cfg device does not impose any specific naming |
|---|
| 63 | 65 | convention on the blobs registered in the file directory, |
|---|
| 64 | 66 | QEMU developers have traditionally used path name semantics |
|---|
| 65 | | - to give each blob a descriptive name. For example: |
|---|
| 67 | + to give each blob a descriptive name. For example:: |
|---|
| 66 | 68 | |
|---|
| 67 | 69 | "bootorder" |
|---|
| 68 | 70 | "genroms/kvmvapic.bin" |
|---|
| .. | .. |
|---|
| 81 | 83 | of directories matching the path name components of fw_cfg |
|---|
| 82 | 84 | blob names, ending in symlinks to the by_key entry for each |
|---|
| 83 | 85 | "basename", as illustrated below (assume current directory is |
|---|
| 84 | | - /sys/firmware): |
|---|
| 86 | + /sys/firmware):: |
|---|
| 85 | 87 | |
|---|
| 86 | 88 | qemu_fw_cfg/by_name/bootorder -> ../by_key/38 |
|---|
| 87 | 89 | qemu_fw_cfg/by_name/etc/e820 -> ../../by_key/35 |
|---|