leandrof/u-boot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
a0abea867a
u-boot/doc
History
Sean Anderson a0abea867a clk: Add driver API to HTML docs 
This converts the existing driver API docs (clk-uclass.h) to kernel doc
format and adds them to the HTML documentation. Because the kernel doc
sphinx converter does not handle functions in structs very well, the
individual methods are documented separately. This is primarily inspired by
the phylink documentation [1], which uses this trick extensively.

[1] https://www.kernel.org/doc/html/latest/networking/kapi.html#c.phylink_mac_ops

Signed-off-by: Sean Anderson <seanga2@gmail.com>
Tested-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Reviewed-by: Simon Glass <sjg@chromium.org>
Link: https://lore.kernel.org/r/20211222171114.3091780-5-seanga2@gmail.com
2022-02-25 01:41:04 -05:00
..
android Create a new boot/ directory 2021-11-11 19:01:56 -05:00
api clk: Add driver API to HTML docs 2022-02-25 01:41:04 -05:00
arch Revert most of the series for adding vexpress_aemv8r support 2021-09-03 10:42:15 -04:00
board doc: board: apple: Update Apple M1 documentation 2022-02-21 08:35:40 -05:00
build doc: fix description of build dependencies for Alpine Linux 2022-01-19 16:18:09 +01:00
chromium doc: Update documentation for cros-2021.04 release 2021-07-15 19:50:28 +08:00
develop tools: mkeficapsule: allow for specifying GUID explicitly 2022-02-11 20:07:55 +01:00
device-tree-bindings remoteproc: k3_system_controller: Support optional boot_notification channel 2022-02-08 09:41:26 -05:00
imx arm: Remove zmx25 board and ARCH_MX25 2021-10-01 21:08:18 -04:00
media doc: Remove duplicated documentation directory 2019-06-20 10:57:08 -04:00
mvebu WS cleanup: remove trailing empty lines 2021-09-30 08:08:56 -04:00
sphinx .readthedocs.yml: update the requirements 2022-01-15 10:57:21 +01:00
sphinx-static doc: Remove duplicated documentation directory 2019-06-20 10:57:08 -04:00
SPI sandbox: update documents regarding spi_sf 2020-05-29 20:55:45 -06:00
SPL net: Rename SPL_NET_SUPPORT to SPL_NET 2021-09-04 12:48:53 -04:00
uImage.FIT mkimage: use environment variable MKIMAGE_SIGN_PIN to set pin for OpenSSL Engine 2021-07-28 20:46:34 -04:00
usage doc: usage: DFU: Fix dfu_alt_info document 2022-02-11 11:29:23 -05:00
.gitignore doc: Add .gitignore for the Sphinx build output directory 2019-07-24 14:15:37 -04:00
bounces patman: add support for omitting bouncing addresses 2017-09-11 21:43:58 -06:00
conf.py doc: fix Latex margins 2021-08-14 20:54:41 +02:00
feature-removal-schedule.txt treewide: mem: Move mtest related defines to Kconfig 2020-05-08 12:02:56 -04:00
git-mailrc MAINTAINERS: Update ARM TI entry 2021-09-09 11:28:54 -04:00
I2C_Edge_Conditions
index.rst doc: move i.MX7D/i.MX8MM A/B booting to board specific 2021-08-17 17:24:07 +02:00
kwboot.1 doc/kwboot.1: Update man page 2021-10-01 11:07:13 +02:00
Makefile doc: handle 'make htmldocs' warnings as errors 2021-08-01 22:23:01 +02:00
mkeficapsule.1 tools: mkeficapsule: allow for specifying GUID explicitly 2022-02-11 20:07:55 +01:00
mkimage.1 mkimage: Improve documentation of algo-name parameter 2022-02-11 11:29:10 -05:00
README.arm-caches
README.arm-relocation treewide: convert bd_t to struct bd_info manually 2020-07-17 10:46:44 -04:00
README.armada-secureboot
README.asn1 doc: add README for asn1 compiler and decoder 2019-12-06 16:44:20 -05:00
README.atmel_mci treewide: convert bd_t to struct bd_info manually 2020-07-17 10:46:44 -04:00
README.atmel_pmecc ARM: at91: Convert SPL_GENERATE_ATMEL_PMECC_HEADER to Kconfig 2019-01-21 08:36:11 -05:00
README.autoboot autoboot: Rename CONFIG_MENUKEY to CONFIG_AUTOBOOT_MENUKEY 2019-08-02 11:19:14 -04:00
README.bcm7xxx board: arm: Add support for Broadcom BCM7445 2018-07-10 16:55:57 -04:00
README.bcmns3 doc: add README doc for bcmns3 platform 2020-07-29 10:37:11 -04:00
README.bitbangMII
README.bootcount bootcount_ext: Add flag to enable/disable bootcount 2020-04-24 10:10:00 -04:00
README.boston
README.bus_vcxk SPDX: Convert all of our single license tags to Linux Kernel style 2018-05-07 09:34:12 -04:00
README.cfi
README.commands.itest
README.commands.spl WS cleanup: remove SPACE(s) followed by TAB 2021-09-30 09:08:16 -04:00
README.console treewide: convert bd_t to struct bd_info manually 2020-07-17 10:46:44 -04:00
README.davinci README: davinci: Clarify when SPL is used and the target devices. 2020-07-13 20:58:34 +05:30
README.davinci.nand_spl
README.dfutftp WS cleanup: remove excessive empty lines 2021-09-30 08:08:56 -04:00
README.displaying-bmps
README.dns
README.enetaddr net: Always build the string_to_enetaddr() helper 2019-12-09 09:47:41 -06:00
README.esbc_validate SPDX: Convert all of our single license tags to Linux Kernel style 2018-05-07 09:34:12 -04:00
README.ext4 fs: Migrate ext4 to Kconfig 2018-01-22 16:43:30 -05:00
README.falcon WS cleanup: remove SPACE(s) followed by TAB 2021-09-30 09:08:16 -04:00
README.fec_mxc
README.fsl_iim
README.fsl-ddr
README.fsl-dpaa
README.fsl-esdhc Move eSDHC adapter card identification to board files 2020-07-27 14:16:28 +05:30
README.fsl-hwconfig
README.fsl-trustzone-components
README.fuse
README.generic_usb_ohci doc: Fix outdated ohci board hook documentation 2019-04-02 12:52:54 +02:00
README.generic-board treewide: convert bd_t to struct bd_info manually 2020-07-17 10:46:44 -04:00
README.gpio dt-bindings: gpio: alignment with kernel v5.3 2020-04-16 23:06:54 -04:00
README.gpt cmd: gpt: Add option to write GPT partitions to environment variable 2021-05-04 12:52:46 -04:00
README.Heterogeneous-SoCs
README.hwconfig
README.i2c
README.iomux SPDX: Convert all of our single license tags to Linux Kernel style 2018-05-07 09:34:12 -04:00
README.JFFS2
README.JFFS2_NAND
README.kconfig
README.kwbimage
README.LED
README.link-local
README.malta
README.marvell Revert "arm64: dts: a3720: add support for espressobin with populated emmc" 2020-12-07 07:11:37 +01:00
README.mediatek doc: README.mediatek: Add a simple README for MediaTek 2018-11-28 23:04:54 -05:00
README.memory-test
README.mpc83xx.ddrecc
README.mpc83xxads
README.mpc85xx freescale/powerpc: Rename the config CONFIG_SECURE_BOOT name 2019-11-08 16:32:08 +05:30
README.mpc85xx-sd-spi-boot
README.mpc85xx-spin-table
README.mpc85xxcds
README.multi-dtb-fit doc: multi-dtb-fit: Remove double underscores 2020-07-17 10:47:19 -04:00
README.mxc_ocotp
README.nand Convert CONFIG_NAND_OMAP_ECCSCHEME to Kconfig 2021-10-06 09:16:24 -04:00
README.odroid WS cleanup: remove SPACE(s) followed by TAB 2021-09-30 09:08:16 -04:00
README.OFT
README.omap3 logicpd: Drop omap3 zoom1 2020-07-09 20:58:05 +05:30
README.omap-ulpi-viewport
README.pblimage
README.pcap WS cleanup: remove trailing empty lines 2021-09-30 08:08:56 -04:00
README.plan9
README.POST treewide: convert bd_t to struct bd_info manually 2020-07-17 10:46:44 -04:00
README.power-framework
README.pxe cmd: pxe_utils: sysboot: add kaslr-seed generation support 2022-02-11 09:00:47 -05:00
README.ramboot-ppc85xx
README.rmobile ARM: rmobile: Add R8A77965 M3NULCB support 2019-04-09 18:19:10 +02:00
README.rockchip doc: rockchip: puma: update build and flash instructions 2021-12-24 14:53:31 +08:00
README.rockusb usb: rockchip: implement K_FW_LBA_ERASE_10 command 2018-08-08 22:22:07 +02:00
README.s5p4418 arm: add (default) config for nanopi2 board 2020-07-29 08:43:40 -04:00
README.s5pc1xx
README.sata
README.sched
README.scrapyard scrapyard: Delete this file and script 2019-09-19 12:54:29 -04:00
README.semihosting vexpress64: Refactor header file to make it easier to add new FVPs 2022-01-04 22:48:48 -05:00
README.serial_multi
README.sha1
README.silent Convert CONFIG_SYS_DEVICE_NULLDEV to Kconfig 2020-08-23 13:43:10 -04:00
README.SNTP
README.socfpga arm: socfpga: arria10: Add qts-filter for Arria10 socfpga 2020-10-09 17:53:14 +08:00
README.SPL spi: Rename SPI_SUPPORT to SPI 2021-09-04 12:26:02 -04:00
README.splashprepare splash: Use splashfile instead of location->name 2019-05-20 11:55:42 +02:00
README.srio-pcie-boot-corenet
README.standalone command: Remove the cmd_tbl_t typedef 2020-05-18 18:36:55 -04:00
README.t1040-l2switch
README.tee Documentation: tee uclass and op-tee driver 2018-10-07 10:47:38 -04:00
README.ti-secure doc: Update info on using K3 secure devices 2019-04-26 17:51:51 -04:00
README.TPL cosmetic: Fix spelling and whitespace errors 2019-12-03 08:43:23 -05:00
README.ubi ubi: Add "skipcheck" command to set/clear this bit in the UBI volume hdr 2019-10-16 05:42:36 +02:00
README.ubispl
README.ublimage
README.udp net: add a generic udp protocol 2020-09-30 16:55:03 -04:00
README.unaligned-memory-access.txt
README.uniphier ARM: uniphier: enable distro boot 2018-07-25 08:47:53 +09:00
README.update cmd: drop fitupd command 2020-07-16 12:37:01 +02:00
README.usb usb: doc: Fix spelling issues in README.usb 2021-11-15 14:33:33 -05:00
README.vf610
README.video video: Add information about using TrueType fonts 2018-12-28 12:26:58 +01:00
README.VLAN
README.VSC3316-3308
README.vxworks bootm: vxworks: Support Linux compatible standard DTB for ARM and PPC 2019-12-03 08:43:23 -05:00
README.watchdog arm: at91: wdt: Convert watchdog driver to dm/dt 2018-11-16 13:34:34 -05:00
README.zfs

README.zfs 

This patch series adds support for ZFS listing and load to u-boot.

To Enable zfs ls and load commands, modify the board specific config file with
#define CONFIG_CMD_ZFS

Steps to test:

1. After applying the patch, zfs specific commands can be seen
   in the boot loader prompt using
	UBOOT #help

	zfsload- load binary file from a ZFS file system
	zfsls  - list files in a directory (default /)

2. To list the files in zfs pool, device or partition, execute
	zfsls <interface> <dev[:part]> [POOL/@/dir/file]
	For example:
	UBOOT #zfsls mmc 0:5 /rpool/@/usr/bin/

3. To read and load a file from an ZFS formatted partition to RAM, execute
	zfsload <interface> <dev[:part]> [addr] [filename] [bytes]
	For example:
	UBOOT #zfsload mmc 2:2 0x30007fc0 /rpool/@/boot/uImage

References :
	-- ZFS GRUB sources from Solaris GRUB-0.97
	-- GRUB Bazaar repository

Jorgen Lundman <lundman at lundman.net> 2012.