serial-howto.txt 2.0 KB

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