dm: Add timeline and guide for porting serial drivers

PATCH Superseded Simon Glass 3 participants 7 messages Nov 20, 2015 – Dec 20, 2015

lore

Share & tools

lore

Simon Glass

author

2015-11-20 17:48 UTC #0 lore raw

PATCH v3 1/1 dm: Add timeline and guide for porting serial drivers

Add a README with a brief guide to porting serial drivers over to use driver model.

Add a timeline also. All serial drivers should be converted by the end of January 2016.

Signed-off-by Simon Glass <[email protected]>

---
To avoid anyone missing out on this, I have added to Cc the all U-Boot maintainers using this:

(for f in $(find . -name MAINTAINERS); do grep ^M: $f; done) | \
	awk '{$1=""; print "Series-cc:" $0}' |sort | uniq

This is about 229 email address, of which 217 seem to be different people.

Changes in v3:
- Fix the date to avoid time machine issues

Changes in v2:
- Copy the patch to all maintainers
- Move the timeline back to January

 doc/driver-model/serial-howto.txt | 58 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 doc/driver-model/serial-howto.txt

doc/driver-model/serial-howto.txt new file +58 -0

new file mode 100644
index 0000000..60483a4
@@ -0,0 +1,58 @@
+How to port a serial driver to driver model
+===========================================
+
+About 16 of 33 serial drivers have been converted as at September 2015. It
+is time for maintainers to start converting over the remaining serial drivers:
+
+   altera_jtag_uart.c
+   altera_uart.c
+   arm_dcc.c
+   lpc32xx_hsuart.c
+   mcfuart.c
+   mxs_auart.c
+   opencores_yanu.c
+   serial_bfin.c
+   serial_imx.c
+   serial_lpuart.c
+   serial_max3100.c
+   serial_pxa.c
+   serial_s3c24x0.c
+   serial_sa1100.c
+   serial_stm32.c
+   serial_xuartlite.c
+   usbtty.c
+
+You should complete this by the end of January 2016.
+
+Here is a suggested approach for converting your serial driver over to driver
+model. Please feel free to update this file with your ideas and suggestions.
+
+- #ifdef out all your own serial driver code (#ifndef CONFIG_DM_SERIAL)
+- Define CONFIG_DM_SERIAL for your board, vendor or architecture
+- If the board does not already use driver model, you need CONFIG_DM also
+- Your board should then build, but will not boot since there will be no serial
+    driver
+- Add the U_BOOT_DRIVER piece at the end (e.g. copy serial_s5p.c for example)
+- Add a private struct for the driver data - avoid using static variables
+- Implement each of the driver methods, perhaps by calling your old methods
+- You may need to adjust the function parameters so that the old and new
+    implementations can share most of the existing code
+- If you convert all existing users of the driver, remove the pre-driver-model
+    code
+
+In terms of patches a conversion series typically has these patches:
+- clean up / prepare the driver for conversion
+- add driver model code
+- convert at least one existing board to use driver model serial
+- (if no boards remain that don't use driver model) remove the old code
+
+This may be a good time to move your board to use device tree also. Mostly
+this involves these steps:
+
+- define CONFIG_OF_CONTROL and CONFIG_OF_SEPARATE
+- add your device tree files to arch/<arch>/dts
+- update the Makefile there
+- Add stdout-path to your /chosen device tree node if it is not already there
+- build and get u-boot-dtb.bin so you can test it
+- Your drivers can now use device tree
+- For device tree in SPL, define CONFIG_SPL_OF_CONTROL

Signature · 1 line

2.6.0.rc2.230.g3dd15c0

Tom Rini

2015-11-20 22:47 UTC #1 lore raw

PATCH v3 1/1 dm: Add timeline and guide for porting serial drivers

Quoted 7 lines · Simon Glass

Add a README with a brief guide to porting serial drivers over to use driver model.
Add a timeline also. All serial drivers should be converted by the end of January 2016.
Signed-off-by Simon Glass <[email protected]>

Applied to u-boot/master, thanks!

Signature · 8 lines

Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 836 bytes
Desc: Digital signature
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20151120/2a8078bb/attachment.sig>

Marek Vasut

2015-12-13 19:55 UTC #2 lore raw

PATCH v3 1/1 dm: Add timeline and guide for porting serial drivers

In reply to Simon Glass

Quoted 39 lines · Simon Glass

Add a README with a brief guide to porting serial drivers over to use driver model.
Add a timeline also. All serial drivers should be converted by the end of January 2016.
Signed-off-by Simon Glass <[email protected]>
---
To avoid anyone missing out on this, I have added to Cc the all U-Boot maintainers using this:
(for f in $(find . -name MAINTAINERS); do grep ^M: $f; done) | \
	awk '{$1=""; print "Series-cc:" $0}' |sort | uniq
This is about 229 email address, of which 217 seem to be different people.
Changes in v3:
- Fix the date to avoid time machine issues
Changes in v2:
- Copy the patch to all maintainers
- Move the timeline back to January
 doc/driver-model/serial-howto.txt | 58
+++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+)
 create mode 100644 doc/driver-model/serial-howto.txt
(quoted diff) +0 -0
b/doc/driver-model/serial-howto.txt new file mode 100644 index 0000000..60483a4
doc/driver-model/serial-howto.txt new file +5 -0
@@ -0,0 +1,58 @@
+How to port a serial driver to driver model
+===========================================
+
+About 16 of 33 serial drivers have been converted as at September 2015. It
+is time for maintainers to start converting over the remaining serial
drivers: +

doc/driver-model/serial-howto.txt line 8

Quoted 2 lines

doc/driver-model/serial-howto.txt new file +2 -0
+   altera_jtag_uart.c
+   altera_uart.c

These are probably already converted.

doc/driver-model/serial-howto.txt line 12

Quoted 4 lines

doc/driver-model/serial-howto.txt new file +4 -0
+   arm_dcc.c
+   lpc32xx_hsuart.c
+   mcfuart.c
+   mxs_auart.c

^ This system does not use DM at all.

doc/driver-model/serial-howto.txt line 15

Quoted 3 lines

doc/driver-model/serial-howto.txt new file +3 -0
+   opencores_yanu.c
+   serial_bfin.c
+   serial_imx.c

DTTO

doc/driver-model/serial-howto.txt line 18

Quoted 3 lines

doc/driver-model/serial-howto.txt new file +3 -0
+   serial_lpuart.c
+   serial_max3100.c
+   serial_pxa.c

DTTO

Quoted 1 line

+ serial_s3c24x0.c

DTTO

Quoted 1 line

+ serial_sa1100.c

This driver is probably dead code

doc/driver-model/serial-howto.txt line 25

Quoted 5 lines

doc/driver-model/serial-howto.txt new file +5 -0

+   serial_stm32.c
+   serial_xuartlite.c
+   usbtty.c
+
+You should complete this by the end of January 2016.

So what do you suggest to do with boards which do not use DM at all ?

Simon Glass

author

2015-12-19 23:07 UTC #3 lore raw

PATCH v3 1/1 dm: Add timeline and guide for porting serial drivers

Hi Marek,

Quoted 72 lines · Marek Vasut

Quoted 39 lines · Simon Glass
Add a README with a brief guide to porting serial drivers over to use driver model.
Add a timeline also. All serial drivers should be converted by the end of January 2016.
Signed-off-by Simon Glass <[email protected]>
---
To avoid anyone missing out on this, I have added to Cc the all U-Boot maintainers using this:
(for f in $(find . -name MAINTAINERS); do grep ^M: $f; done) | \
      awk '{$1=""; print "Series-cc:" $0}' |sort | uniq
This is about 229 email address, of which 217 seem to be different people.
Changes in v3:
- Fix the date to avoid time machine issues
Changes in v2:
- Copy the patch to all maintainers
- Move the timeline back to January
 doc/driver-model/serial-howto.txt | 58
+++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+)
 create mode 100644 doc/driver-model/serial-howto.txt
(quoted diff) +0 -0
b/doc/driver-model/serial-howto.txt new file mode 100644 index 0000000..60483a4
doc/driver-model/serial-howto.txt new file +5 -0
@@ -0,0 +1,58 @@
+How to port a serial driver to driver model
+===========================================
+
+About 16 of 33 serial drivers have been converted as at September 2015. It
+is time for maintainers to start converting over the remaining serial
drivers: +
doc/driver-model/serial-howto.txt line 8
Quoted 2 lines
doc/driver-model/serial-howto.txt new file +2 -0
+   altera_jtag_uart.c
+   altera_uart.c
These are probably already converted.
doc/driver-model/serial-howto.txt line 12
Quoted 4 lines
doc/driver-model/serial-howto.txt new file +4 -0
+   arm_dcc.c
+   lpc32xx_hsuart.c
+   mcfuart.c
+   mxs_auart.c
^ This system does not use DM at all.
doc/driver-model/serial-howto.txt line 15
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   opencores_yanu.c
+   serial_bfin.c
+   serial_imx.c
DTTO
doc/driver-model/serial-howto.txt line 18
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   serial_lpuart.c
+   serial_max3100.c
+   serial_pxa.c
DTTO
Quoted 1 line
+ serial_s3c24x0.c
DTTO
Quoted 1 line
+ serial_sa1100.c
This driver is probably dead code

Quoted 7 lines

doc/driver-model/serial-howto.txt line 25
Quoted 5 lines
doc/driver-model/serial-howto.txt new file +5 -0
+   serial_stm32.c
+   serial_xuartlite.c
+   usbtty.c
+
+You should complete this by the end of January 2016.
So what do you suggest to do with boards which do not use DM at all ?

I'd say move them over...

Regards,
Simon

Marek Vasut

2015-12-19 23:56 UTC #4 lore raw

PATCH v3 1/1 dm: Add timeline and guide for porting serial drivers

Quoted 87 lines · Simon Glass

Hi Marek,
Quoted 76 lines · Marek Vasut
Quoted 43 lines · Simon Glass
Add a README with a brief guide to porting serial drivers over to use driver model.
Add a timeline also. All serial drivers should be converted by the end of January 2016.
Signed-off-by Simon Glass <[email protected]>
---
To avoid anyone missing out on this, I have added to Cc the all U-Boot maintainers using this:
(for f in $(find . -name MAINTAINERS); do grep ^M: $f; done) | \
      awk '{$1=""; print "Series-cc:" $0}' |sort | uniq
This is about 229 email address, of which 217 seem to be different people.
Changes in v3:
- Fix the date to avoid time machine issues
Changes in v2:
- Copy the patch to all maintainers
- Move the timeline back to January
 doc/driver-model/serial-howto.txt | 58
+++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+)
 create mode 100644 doc/driver-model/serial-howto.txt
(quoted diff) +0 -0
b/doc/driver-model/serial-howto.txt new file mode 100644 index 0000000..60483a4
doc/driver-model/serial-howto.txt new file +4 -0
@@ -0,0 +1,58 @@
+How to port a serial driver to driver model
+===========================================
+
+About 16 of 33 serial drivers have been converted as at September 2015.
It +is time for maintainers to start converting over the remaining serial drivers: +
doc/driver-model/serial-howto.txt line 8
Quoted 2 lines
doc/driver-model/serial-howto.txt new file +2 -0
+   altera_jtag_uart.c
+   altera_uart.c
These are probably already converted.
doc/driver-model/serial-howto.txt line 12
Quoted 4 lines
doc/driver-model/serial-howto.txt new file +4 -0
+   arm_dcc.c
+   lpc32xx_hsuart.c
+   mcfuart.c
+   mxs_auart.c
^ This system does not use DM at all.
doc/driver-model/serial-howto.txt line 15
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   opencores_yanu.c
+   serial_bfin.c
+   serial_imx.c
DTTO
doc/driver-model/serial-howto.txt line 18
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   serial_lpuart.c
+   serial_max3100.c
+   serial_pxa.c
DTTO
Quoted 1 line
+ serial_s3c24x0.c
DTTO
Quoted 1 line
+ serial_sa1100.c
This driver is probably dead code
Quoted 7 lines
doc/driver-model/serial-howto.txt line 25
Quoted 5 lines
doc/driver-model/serial-howto.txt new file +5 -0
+   serial_stm32.c
+   serial_xuartlite.c
+   usbtty.c
+
+You should complete this by the end of January 2016.
So what do you suggest to do with boards which do not use DM at all ?

Quoted 1 line

I'd say move them over...

That's not doable this late in the RC cycle though. I would suggest to postpone the date.

Simon Glass

author

2015-12-20 02:40 UTC #5 lore raw

PATCH v3 1/1 dm: Add timeline and guide for porting serial drivers

Hi Marek,

Quoted 88 lines · Marek Vasut

Quoted 87 lines · Simon Glass
Hi Marek,
Quoted 83 lines · Marek Vasut
Quoted 43 lines · Simon Glass
Add a README with a brief guide to porting serial drivers over to use driver model.
Add a timeline also. All serial drivers should be converted by the end of January 2016.
Signed-off-by Simon Glass <[email protected]>
---
To avoid anyone missing out on this, I have added to Cc the all U-Boot maintainers using this:
(for f in $(find . -name MAINTAINERS); do grep ^M: $f; done) | \
      awk '{$1=""; print "Series-cc:" $0}' |sort | uniq
This is about 229 email address, of which 217 seem to be different people.
Changes in v3:
- Fix the date to avoid time machine issues
Changes in v2:
- Copy the patch to all maintainers
- Move the timeline back to January
 doc/driver-model/serial-howto.txt | 58
+++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+)
 create mode 100644 doc/driver-model/serial-howto.txt
(quoted diff) +0 -0
b/doc/driver-model/serial-howto.txt new file mode 100644 index 0000000..60483a4
doc/driver-model/serial-howto.txt new file +4 -0
@@ -0,0 +1,58 @@
+How to port a serial driver to driver model
+===========================================
+
+About 16 of 33 serial drivers have been converted as at September 2015.
It +is time for maintainers to start converting over the remaining serial drivers: +
doc/driver-model/serial-howto.txt line 8
Quoted 2 lines
doc/driver-model/serial-howto.txt new file +2 -0
+   altera_jtag_uart.c
+   altera_uart.c
These are probably already converted.
doc/driver-model/serial-howto.txt line 12
Quoted 4 lines
doc/driver-model/serial-howto.txt new file +4 -0
+   arm_dcc.c
+   lpc32xx_hsuart.c
+   mcfuart.c
+   mxs_auart.c
^ This system does not use DM at all.
doc/driver-model/serial-howto.txt line 15
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   opencores_yanu.c
+   serial_bfin.c
+   serial_imx.c
DTTO
doc/driver-model/serial-howto.txt line 18
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   serial_lpuart.c
+   serial_max3100.c
+   serial_pxa.c
DTTO
Quoted 1 line
+ serial_s3c24x0.c
DTTO
Quoted 1 line
+ serial_sa1100.c
This driver is probably dead code
doc/driver-model/serial-howto.txt line 25
Quoted 5 lines
doc/driver-model/serial-howto.txt new file +5 -0
+   serial_stm32.c
+   serial_xuartlite.c
+   usbtty.c
+
+You should complete this by the end of January 2016.
So what do you suggest to do with boards which do not use DM at all ?

Quoted 4 lines

Quoted 1 line
I'd say move them over...
That's not doable this late in the RC cycle though. I would suggest to postpone the date.

Well we still have 6 weeks until the end of January for people to produce patches. Merging them might take a while, but hopefully we can finish this for the 2016.07 release.

Regards,
Simon

Marek Vasut

2015-12-20 02:57 UTC #6 lore raw

PATCH v3 1/1 dm: Add timeline and guide for porting serial drivers

Quoted 92 lines · Simon Glass

Hi Marek,
Quoted 89 lines · Marek Vasut
Quoted 88 lines · Simon Glass
Hi Marek,
Quoted 84 lines · Marek Vasut
Quoted 44 lines · Simon Glass
Add a README with a brief guide to porting serial drivers over to use driver model.
Add a timeline also. All serial drivers should be converted by the end of January 2016.
Signed-off-by Simon Glass <[email protected]>
---
To avoid anyone missing out on this, I have added to Cc the all U-Boot maintainers using this:
(for f in $(find . -name MAINTAINERS); do grep ^M: $f; done) | \
      awk '{$1=""; print "Series-cc:" $0}' |sort | uniq
This is about 229 email address, of which 217 seem to be different people.
Changes in v3:
- Fix the date to avoid time machine issues
Changes in v2:
- Copy the patch to all maintainers
- Move the timeline back to January
 doc/driver-model/serial-howto.txt | 58
+++++++++++++++++++++++++++++++++++++++ 1 file changed, 58 insertions(+)
 create mode 100644 doc/driver-model/serial-howto.txt
(quoted diff) +0 -0
b/doc/driver-model/serial-howto.txt new file mode 100644 index 0000000..60483a4
doc/driver-model/serial-howto.txt new file +4 -0
@@ -0,0 +1,58 @@
+How to port a serial driver to driver model
+===========================================
+
+About 16 of 33 serial drivers have been converted as at September
2015. It +is time for maintainers to start converting over the remaining serial drivers: +
doc/driver-model/serial-howto.txt line 8
Quoted 2 lines
doc/driver-model/serial-howto.txt new file +2 -0
+   altera_jtag_uart.c
+   altera_uart.c
These are probably already converted.
doc/driver-model/serial-howto.txt line 12
Quoted 4 lines
doc/driver-model/serial-howto.txt new file +4 -0
+   arm_dcc.c
+   lpc32xx_hsuart.c
+   mcfuart.c
+   mxs_auart.c
^ This system does not use DM at all.
doc/driver-model/serial-howto.txt line 15
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   opencores_yanu.c
+   serial_bfin.c
+   serial_imx.c
DTTO
doc/driver-model/serial-howto.txt line 18
Quoted 3 lines
doc/driver-model/serial-howto.txt new file +3 -0
+   serial_lpuart.c
+   serial_max3100.c
+   serial_pxa.c
DTTO
Quoted 1 line
+ serial_s3c24x0.c
DTTO
Quoted 1 line
+ serial_sa1100.c
This driver is probably dead code
doc/driver-model/serial-howto.txt line 25
Quoted 5 lines
doc/driver-model/serial-howto.txt new file +5 -0
+   serial_stm32.c
+   serial_xuartlite.c
+   usbtty.c
+
+You should complete this by the end of January 2016.
So what do you suggest to do with boards which do not use DM at all ?

Quoted 8 lines

Quoted 4 lines
Quoted 1 line
I'd say move them over...
That's not doable this late in the RC cycle though. I would suggest to postpone the date.
Well we still have 6 weeks until the end of January for people to produce patches. Merging them might take a while, but hopefully we can finish this for the 2016.07 release.

I see.