i2c-howto.txt 2.1 KB

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