serial-howto.txt 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
  1. How to port a serial driver to driver model
  2. ===========================================
  3. About 16 of 33 serial drivers have been converted as at September 2015. It
  4. is time for maintainers to start converting over the remaining serial drivers:
  5. arm_dcc.c
  6. lpc32xx_hsuart.c
  7. mcfuart.c
  8. mxs_auart.c
  9. opencores_yanu.c
  10. serial_bfin.c
  11. serial_imx.c
  12. serial_lpuart.c
  13. serial_max3100.c
  14. serial_pxa.c
  15. serial_s3c24x0.c
  16. serial_sa1100.c
  17. serial_xuartlite.c
  18. usbtty.c
  19. You should complete this by the end of January 2016.
  20. Here is a suggested approach for converting your serial driver over to driver
  21. model. Please feel free to update this file with your ideas and suggestions.
  22. - #ifdef out all your own serial driver code (#ifndef CONFIG_DM_SERIAL)
  23. - Define CONFIG_DM_SERIAL for your board, vendor or architecture
  24. - If the board does not already use driver model, you need CONFIG_DM also
  25. - Your board should then build, but will not boot since there will be no serial
  26. driver
  27. - Add the U_BOOT_DRIVER piece at the end (e.g. copy serial_s5p.c for example)
  28. - Add a private struct for the driver data - avoid using static variables
  29. - Implement each of the driver methods, perhaps by calling your old methods
  30. - You may need to adjust the function parameters so that the old and new
  31. implementations can share most of the existing code
  32. - If you convert all existing users of the driver, remove the pre-driver-model
  33. code
  34. In terms of patches a conversion series typically has these patches:
  35. - clean up / prepare the driver for conversion
  36. - add driver model code
  37. - convert at least one existing board to use driver model serial
  38. - (if no boards remain that don't use driver model) remove the old code
  39. This may be a good time to move your board to use device tree also. Mostly
  40. this involves these steps:
  41. - define CONFIG_OF_CONTROL and CONFIG_OF_SEPARATE
  42. - add your device tree files to arch/<arch>/dts
  43. - update the Makefile there
  44. - Add stdout-path to your /chosen device tree node if it is not already there
  45. - build and get u-boot-dtb.bin so you can test it
  46. - Your drivers can now use device tree
  47. - For device tree in SPL, define CONFIG_SPL_OF_CONTROL