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