Changeset View
Changeset View
Standalone View
Standalone View
head/share/man/man4/fdt.4
| Show All 22 Lines | |||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | ||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd July 12, 2010 | .Dd March 28, 2019 | ||||
| .Dt FDT 4 | .Dt FDT 4 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm fdt | .Nm fdt | ||||
| .Nd Flattened Device Tree support | .Nd Flattened Device Tree support | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| .Cd "options FDT" | .Cd "options FDT" | ||||
| .Cd "makeoptions FDT_DTS_FILE=<board name>.dts" | .Cd "makeoptions FDT_DTS_FILE=<board name>.dts" | ||||
| ▲ Show 20 Lines • Show All 94 Lines • ▼ Show 20 Lines | |||||
| .Xr loader 8 . | .Xr loader 8 . | ||||
| .Sh "BUILDING KERNEL" | .Sh "BUILDING KERNEL" | ||||
| There is a couple of options for managing | There is a couple of options for managing | ||||
| .Nm | .Nm | ||||
| support at the | support at the | ||||
| .Fx | .Fx | ||||
| kernel level. | kernel level. | ||||
| .Bl -tag -width Ar | .Bl -tag -width Ar | ||||
| .It Va makeoptions DTS+=<board name>.dts | |||||
| Specifies device tree source (DTS) files for a given kernel. | |||||
| The indicated DTS files will be converted (compiled) into a binary form | |||||
| along with building the kernel itself. | |||||
| Any DTS file names not written as an absolute path must be specified relative | |||||
| to the default location of DTS sources i.e., | |||||
| .Pa sys/dts . | |||||
| .It Va makeoptions DTSO+=<overlay name>.dtso | |||||
| Specifies device tree source overlay (DTSO) files for a given kernel. | |||||
| Overlay files will be built with the kernel as with the makeoption | |||||
| .Va DTS | |||||
| described above. | |||||
| Overlay files specified as relative paths will be relative to the default | |||||
| location of DTS overlays for the platform being built i.e., | |||||
| .Pa sys/dts/arm/overlays . | |||||
| .It Va options FDT | .It Va options FDT | ||||
| The primary option for enabling | The primary option for enabling | ||||
| .Nm | .Nm | ||||
| support in the kernel. | support in the kernel. | ||||
| It covers all low-level and infrastructure parts of | It covers all low-level and infrastructure parts of | ||||
| .Nm | .Nm | ||||
| kernel support, which primarily are the | kernel support, which primarily are the | ||||
| .Xr fdtbus 4 | .Xr fdtbus 4 | ||||
| and | and | ||||
| .Xr simplebus 4 | .Xr simplebus 4 | ||||
| drivers, as well as helper routines and libraries. | drivers, as well as helper routines and libraries. | ||||
| .It Va makeoptions FDT_DTS_FILE=<board name>.dts | .It Va makeoptions FDT_DTS_FILE=<board name>.dts | ||||
| Specifies a preferred (default) device tree source (DTS) file for a given | Specifies a preferred (default) device tree source (DTS) file for a given | ||||
| kernel. | kernel. | ||||
| The indicated DTS file will be converted (compiled) into a binary form | It will be built along with the kernel as if it were supplied via the makeoption | ||||
| along with building the kernel itself. | .Va DTS | ||||
| The DTS file name is relative to the default location of DTS sources i.e. | described above. | ||||
| .Pa sys/dts . | |||||
| This makeoption is not mandatory unless FDT_DTB_STATIC is also defined (see | This makeoption is not mandatory unless FDT_DTB_STATIC is also defined (see | ||||
| below). | below). | ||||
| .It Va options FDT_DTB_STATIC | .It Va options FDT_DTB_STATIC | ||||
| Typically, the device tree blob (DTB) is a stand-alone file, physically | Typically, the device tree blob (DTB) is a stand-alone file, physically | ||||
| separate from the kernel, but this option lets statically embed a | separate from the kernel, but this option lets statically embed a | ||||
| DTB file into a kernel image. | DTB file into a kernel image. | ||||
| Note that when this is specified the | Note that when this is specified the | ||||
| FDT_DTS_FILE makeoption becomes mandatory (as there needs to be a DTS file | FDT_DTS_FILE makeoption becomes mandatory (as there needs to be a DTS file | ||||
| Show All 25 Lines | |||||