Gitiles
Code Review Sign In
gerrit.devboardsforandroid.linaro.org / platform / external / u-boot / cb5d0419f5517c507685577dca41c9085b7d77c4 / . / doc / develop / driver-model / migration.rst
blob: 5a6043692585c9952ec3fbcd997c145fc57cb22b [file] [log] [blame]
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]1.. SPDX-License-Identifier: GPL-2.0+
2
Simon Glass302466d2017-08-05 15:45:53 -0600[diff] [blame]3Migration Schedule
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]4==================
Simon Glass302466d2017-08-05 15:45:53 -0600[diff] [blame]5
6U-Boot has been migrating to a new driver model since its introduction in
72014. This file describes the schedule for deprecation of pre-driver-model
8features.
9
Heinrich Schuchardt282ed242019-09-16 18:41:42 +0200[diff] [blame]10CONFIG_DM
11---------
12
13* Status: In progress
14* Deadline: 2020.01
15
16Starting with the 2010.01 release CONFIG_DM will be enabled for all boards.
17This does not concern CONFIG_DM_SPL and CONFIG_DM_TPL. The conversion date for
18these configuration items still needs to be defined.
19
Tom Rini1cb5d5d2018-11-29 18:21:11 -0500[diff] [blame]20CONFIG_DM_MMC
21-------------
22
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]23* Status: In progress
24* Deadline: 2019.04
Tom Rini1cb5d5d2018-11-29 18:21:11 -0500[diff] [blame]25
26The subsystem itself has been converted and maintainers should submit patches
27switching over to using CONFIG_DM_MMC and other base driver model options in
28time for inclusion in the 2019.04 rerelease.
Simon Glass302466d2017-08-05 15:45:53 -0600[diff] [blame]29
Tom Rini109d8bf2018-11-29 18:21:12 -0500[diff] [blame]30CONFIG_DM_USB
31-------------
32
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]33* Status: In progress
34* Deadline: 2019.07
Tom Rini109d8bf2018-11-29 18:21:12 -0500[diff] [blame]35
36The subsystem itself has been converted along with many of the host controller
37and maintainers should submit patches switching over to using CONFIG_DM_USB and
38other base driver model options in time for inclusion in the 2019.07 rerelease.
39
Tom Riniea9d7c12018-11-29 18:21:13 -0500[diff] [blame]40CONFIG_SATA
41-----------
42
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]43* Status: In progress
44* Deadline: 2019.07
Tom Riniea9d7c12018-11-29 18:21:13 -0500[diff] [blame]45
46The subsystem itself has been converted along with many of the host controller
47and maintainers should submit patches switching over to using CONFIG_AHCI and
48other base driver model options in time for inclusion in the 2019.07 rerelease.
49
Simon Glass302466d2017-08-05 15:45:53 -0600[diff] [blame]50CONFIG_BLK
51----------
52
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]53* Status: In progress
54* Deadline: 2019.07
Simon Glass302466d2017-08-05 15:45:53 -0600[diff] [blame]55
Tom Rini7cfc1a32018-11-29 18:21:14 -0500[diff] [blame]56In concert with maintainers migrating their block device usage to the
57appropriate DM driver, CONFIG_BLK needs to be set as well. The final deadline
58here coincides with the final deadline for migration of the various block
Tom Rini91ff6862018-12-05 08:23:38 -0500[diff] [blame]59subsystems. At this point we will be able to audit and correct the logic in
60Kconfig around using CONFIG_PARTITIONS and CONFIG_HAVE_BLOCK_DEVICE and make
61use of CONFIG_BLK / CONFIG_SPL_BLK as needed.
Jagan Tekic4e68d32018-03-14 18:58:03 +0530[diff] [blame]62
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]63CONFIG_DM_SPI / CONFIG_DM_SPI_FLASH
64-----------------------------------
Jagan Tekic4e68d32018-03-14 18:58:03 +0530[diff] [blame]65
66Board Maintainers should submit the patches for enabling DM_SPI and DM_SPI_FLASH
67to move the migration with in the deadline.
68
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]69Partially converted::
70
Jagan Teki18c56602020-07-09 21:23:58 +0530[diff] [blame]71 drivers/spi/fsl_espi.c
Jagan Tekic4e68d32018-03-14 18:58:03 +0530[diff] [blame]72 drivers/spi/mxc_spi.c
Jagan Tekid1505ad2019-04-29 01:58:54 +0530[diff] [blame]73 drivers/spi/sh_qspi.c
Jagan Tekic4e68d32018-03-14 18:58:03 +0530[diff] [blame]74
Bin Menge1910d92019-07-18 00:33:50 -0700[diff] [blame]75* Status: In progress
76* Deadline: 2019.07
Simon Glass1ce689d2018-12-28 14:03:07 -0700[diff] [blame]77
Simon Glass3e87ffc2018-12-28 14:03:08 -0700[diff] [blame]78CONFIG_DM_VIDEO
79---------------
80Deadline: 2019.07
81
82The video subsystem has supported driver model since early 2016. Maintainers
83should submit patches switching over to using CONFIG_DM_VIDEO and other base
84driver model options in time for inclusion in the 2019.07 release.
Heinrich Schuchardt2e0f3242019-08-10 00:10:37 +0200[diff] [blame]85
86CONFIG_DM_ETH
87-------------
88Deadline: 2020.07
89
90The network subsystem has supported the driver model since early 2015.
91Maintainers should submit patches switching over to using CONFIG_DM_ETH and
92other base driver model options in time for inclusion in the 2020.07 release.
Simon Glass65c8cdc2021-03-25 21:24:44 +1300[diff] [blame]93
94CONFIG_DM_I2C
95-------------
96Deadline: 2021.10
97
98The I2C subsystem has supported the driver model since early 2015.
99Maintainers should submit patches switching over to using CONFIG_DM_I2C and
100other base driver model options in time for inclusion in the 2021.10 release.
Simon Glass6ce22372021-11-24 09:26:45 -0700[diff] [blame]101
102CONFIG_KEYBOARD
103---------------
104Deadline: 2022.10
105
106This is a legacy option which has been replaced by driver model.
107Maintainers should submit patches switching over to using CONFIG_DM_KEYBOARD and
108other base driver model options in time for inclusion in the 2022.10 release.
Simon Glass6e4a7ea2021-12-18 11:27:29 -0700[diff] [blame]109
110CONFIG_SYS_TIMER_RATE and CONFIG_SYS_TIMER_COUNTER
111--------------------------------------------------
112Deadline: 2023.01
113
114These are legacy options which have been replaced by driver model.
115Maintainers should submit patches switching over to using CONFIG_TIMER and
116other base driver model options in time for inclusion in the 2022.10 release.
117
118There is only one method to implement, unless you want to support bootstage,
119in which case you need an early timer also. For example drivers, see
120sandbox_timer.c and rockchip_timer.c
Simon Glass90533742022-01-22 05:03:50 -0700[diff] [blame]121
122CONFIG_DM_SERIAL
123----------------
124Deadline: 2023.04
125
126The serial subsystem has supported the driver model since late 2014.
127Maintainers should submit patches switching over to using CONFIG_DM_SERIAL and
128other base driver model options in time for inclusion in the 2022.10 release.