git.sur5r.net Git - u-boot/blob - doc/driver-model/serial-howto.txt

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