From: Bin Meng Date: Thu, 18 Jul 2019 07:33:50 +0000 (-0700) Subject: doc: driver-model: Convert MIGRATION.txt to reST X-Git-Tag: v2019.10-rc1~16^2~45 X-Git-Url: https://git.librecmc.org/?a=commitdiff_plain;h=e1910d93b8906f9366f6661adca7a58d4b98dd61;p=oweals%2Fu-boot.git doc: driver-model: Convert MIGRATION.txt to reST Convert plain text documentation to reStructuredText format and add it to Sphinx TOC tree. No essential content change. Signed-off-by: Bin Meng Reviewed-by: Heinrich Schuchardt --- diff --git a/doc/driver-model/MIGRATION.txt b/doc/driver-model/MIGRATION.txt deleted file mode 100644 index d38be3538a..0000000000 --- a/doc/driver-model/MIGRATION.txt +++ /dev/null @@ -1,101 +0,0 @@ -Migration Schedule -==================== - -U-Boot has been migrating to a new driver model since its introduction in -2014. This file describes the schedule for deprecation of pre-driver-model -features. - -CONFIG_DM_MMC -------------- - -Status: In progress -Deadline: 2019.04 - -The subsystem itself has been converted and maintainers should submit patches -switching over to using CONFIG_DM_MMC and other base driver model options in -time for inclusion in the 2019.04 rerelease. - -CONFIG_DM_USB -------------- - -Status: In progress -Deadline: 2019.07 - -The subsystem itself has been converted along with many of the host controller -and maintainers should submit patches switching over to using CONFIG_DM_USB and -other base driver model options in time for inclusion in the 2019.07 rerelease. - -CONFIG_SATA ------------ - -Status: In progress -Deadline: 2019.07 - -The subsystem itself has been converted along with many of the host controller -and maintainers should submit patches switching over to using CONFIG_AHCI and -other base driver model options in time for inclusion in the 2019.07 rerelease. - -CONFIG_BLK ----------- - -Status: In progress -Deadline: 2019.07 - -In concert with maintainers migrating their block device usage to the -appropriate DM driver, CONFIG_BLK needs to be set as well. The final deadline -here coincides with the final deadline for migration of the various block -subsystems. At this point we will be able to audit and correct the logic in -Kconfig around using CONFIG_PARTITIONS and CONFIG_HAVE_BLOCK_DEVICE and make -use of CONFIG_BLK / CONFIG_SPL_BLK as needed. - -CONFIG_DM_SPI -CONFIG_DM_SPI_FLASH -------------------- - -Board Maintainers should submit the patches for enabling DM_SPI and DM_SPI_FLASH -to move the migration with in the deadline. - -No dm conversion yet: - drivers/spi/cf_spi.c - drivers/spi/fsl_espi.c - drivers/spi/lpc32xx_ssp.c - drivers/spi/mxs_spi.c - drivers/spi/sh_spi.c - drivers/spi/soft_spi_legacy.c - - Status: In progress - Deadline: 2019.04 - -Partially converted: - drivers/spi/davinci_spi.c - drivers/spi/fsl_dspi.c - drivers/spi/kirkwood_spi.c - drivers/spi/mxc_spi.c - drivers/spi/omap3_spi.c - drivers/spi/sh_qspi.c - - Status: In progress - Deadline: 2019.07 - --- -Jagan Teki -12/24/2018 -03/14/2018 - - -CONFIG_DM_PCI -------------- -Deadline: 2019.07 - -The PCI subsystem has supported driver model since mid 2015. Maintainers should -submit patches switching over to using CONFIG_DM_PCI and other base driver -model options in time for inclusion in the 2019.07 release. - - -CONFIG_DM_VIDEO ---------------- -Deadline: 2019.07 - -The video subsystem has supported driver model since early 2016. Maintainers -should submit patches switching over to using CONFIG_DM_VIDEO and other base -driver model options in time for inclusion in the 2019.07 release. diff --git a/doc/driver-model/index.rst b/doc/driver-model/index.rst index 96fbd7213a..663aa5d499 100644 --- a/doc/driver-model/index.rst +++ b/doc/driver-model/index.rst @@ -7,3 +7,4 @@ Driver Model :maxdepth: 2 design + migration diff --git a/doc/driver-model/migration.rst b/doc/driver-model/migration.rst new file mode 100644 index 0000000000..a26e7ab7e1 --- /dev/null +++ b/doc/driver-model/migration.rst @@ -0,0 +1,99 @@ +.. SPDX-License-Identifier: GPL-2.0+ + +Migration Schedule +================== + +U-Boot has been migrating to a new driver model since its introduction in +2014. This file describes the schedule for deprecation of pre-driver-model +features. + +CONFIG_DM_MMC +------------- + +* Status: In progress +* Deadline: 2019.04 + +The subsystem itself has been converted and maintainers should submit patches +switching over to using CONFIG_DM_MMC and other base driver model options in +time for inclusion in the 2019.04 rerelease. + +CONFIG_DM_USB +------------- + +* Status: In progress +* Deadline: 2019.07 + +The subsystem itself has been converted along with many of the host controller +and maintainers should submit patches switching over to using CONFIG_DM_USB and +other base driver model options in time for inclusion in the 2019.07 rerelease. + +CONFIG_SATA +----------- + +* Status: In progress +* Deadline: 2019.07 + +The subsystem itself has been converted along with many of the host controller +and maintainers should submit patches switching over to using CONFIG_AHCI and +other base driver model options in time for inclusion in the 2019.07 rerelease. + +CONFIG_BLK +---------- + +* Status: In progress +* Deadline: 2019.07 + +In concert with maintainers migrating their block device usage to the +appropriate DM driver, CONFIG_BLK needs to be set as well. The final deadline +here coincides with the final deadline for migration of the various block +subsystems. At this point we will be able to audit and correct the logic in +Kconfig around using CONFIG_PARTITIONS and CONFIG_HAVE_BLOCK_DEVICE and make +use of CONFIG_BLK / CONFIG_SPL_BLK as needed. + +CONFIG_DM_SPI / CONFIG_DM_SPI_FLASH +----------------------------------- + +Board Maintainers should submit the patches for enabling DM_SPI and DM_SPI_FLASH +to move the migration with in the deadline. + +No dm conversion yet:: + + drivers/spi/cf_spi.c + drivers/spi/fsl_espi.c + drivers/spi/lpc32xx_ssp.c + drivers/spi/mxs_spi.c + drivers/spi/sh_spi.c + drivers/spi/soft_spi_legacy.c + +* Status: In progress +* Deadline: 2019.04 + +Partially converted:: + + drivers/spi/davinci_spi.c + drivers/spi/fsl_dspi.c + drivers/spi/kirkwood_spi.c + drivers/spi/mxc_spi.c + drivers/spi/omap3_spi.c + drivers/spi/sh_qspi.c + +* Status: In progress +* Deadline: 2019.07 + + +CONFIG_DM_PCI +------------- +Deadline: 2019.07 + +The PCI subsystem has supported driver model since mid 2015. Maintainers should +submit patches switching over to using CONFIG_DM_PCI and other base driver +model options in time for inclusion in the 2019.07 release. + + +CONFIG_DM_VIDEO +--------------- +Deadline: 2019.07 + +The video subsystem has supported driver model since early 2016. Maintainers +should submit patches switching over to using CONFIG_DM_VIDEO and other base +driver model options in time for inclusion in the 2019.07 release.