diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/driver-model/index.rst | 1 | ||||
| -rw-r--r-- | doc/driver-model/soc-framework.rst | 68 | ||||
| -rw-r--r-- | doc/mkimage.1 | 9 |
3 files changed, 0 insertions, 78 deletions
diff --git a/doc/driver-model/index.rst b/doc/driver-model/index.rst index f17c72ce69..b9df221627 100644 --- a/doc/driver-model/index.rst +++ b/doc/driver-model/index.rst @@ -19,6 +19,5 @@ Driver Model pmic-framework remoteproc-framework serial-howto - soc-framework spi-howto usb-info diff --git a/doc/driver-model/soc-framework.rst b/doc/driver-model/soc-framework.rst deleted file mode 100644 index 2609fda644..0000000000 --- a/doc/driver-model/soc-framework.rst +++ /dev/null @@ -1,68 +0,0 @@ -.. SPDX-License-Identifier: GPL-2.0+ -.. (C) Copyright 2020 -.. Texas Instruments Incorporated - http://www.ti.com/ - -SOC ID Framework -================ - -Introduction ------------- - -The driver-model SOC ID framework is able to provide identification -information about a specific SoC in use at runtime, and also provide matching -from a set of identification information from an array. This can be useful for -enabling small quirks in drivers that exist between SoC variants that are -impractical to implement using device tree flags. It is based on UCLASS_SOC. - -UCLASS_SOC: - - drivers/soc/soc-uclass.c - - include/soc.h - -Configuration: - - CONFIG_SOC_DEVICE is selected by drivers as needed. - -Implementing a UCLASS_SOC provider ----------------------------------- - -The purpose of this framework is to allow UCLASS_SOC provider drivers to supply -identification information about the SoC in use at runtime. The framework -allows drivers to define soc_ops that return identification strings. All -soc_ops need not be defined and can be left as NULL, in which case the -framework will return -ENOSYS and not consider the value when doing an -soc_device_match. - -It is left to the driver implementor to decide how the information returned is -determined, but in general the same SOC should always return the same set of -identifying information. Information returned must be in the form of a NULL -terminated string. - -See include/soc.h for documentation of the available soc_ops and the intended -meaning of the values that can be returned. See drivers/soc/soc_sandbox.c for -an example UCLASS_SOC provider driver. - -Using a UCLASS_SOC driver -------------------------- - -The framework provides the ability to retrieve and use the identification -strings directly. It also has the ability to return a match from a list of -different sets of SoC data using soc_device_match. - -An array of 'struct soc_attr' can be defined, each containing ID information -for a specific SoC, and when passed to soc_device_match, the identifier values -for each entry in the list will be compared against the values provided by the -UCLASS_SOC driver that is in use. The first entry in the list that matches all -non-null values will be returned by soc_device_match. - -An example of various uses of the framework can be found at test/dm/soc.c. - -Describing the device using device tree ---------------------------------------- - -.. code-block:: none - - chipid: chipid { - compatible = "sandbox,soc"; - }; - -All that is required in a DT node is a compatible for a corresponding -UCLASS_SOC driver. diff --git a/doc/mkimage.1 b/doc/mkimage.1 index fea5288784..3dcdcedcef 100644 --- a/doc/mkimage.1 +++ b/doc/mkimage.1 @@ -167,15 +167,6 @@ Specifies that keys used to sign the FIT are required. This means that they must be verified for the image to boot. Without this option, the verification will be optional (useful for testing but not for release). -.TP -.BI "\-t -Update the timestamp in the FIT. - -Normally the FIT timestamp is created the first time mkimage is run on a FIT, -when converting the source .its to the binary .fit file. This corresponds to -using the -f flag. But if the original input to mkimage is a binary file -(already compiled) then the timestamp is assumed to have been set previously. - .SH EXAMPLES List image information: |