docs/platform-hooks.md

   1 Hooks can be defined per supported platform to allow for highly custom operations if needed.
   2 This feature of MRAA should only be used by developers defining the board definitions, NOT an end user.
   3
   4 ##Types of Hooks
   5
   6 ###REPLACE
   7 Defining a replace function will entirely replace the associate function. This should only be done if your new function can handle everything the mraa function would normally.
   8
   9 ###PRE
  10 Any functionality defined here will be performed when the main function is called.
  11
  12 ###POST
  13 Any functionality perfomed here is done just before the normal function returns. All post functions will have passed into them the return value that would normally be returned.
  14
  15 ##Hooks
  16 ### GPIO
  17  * init (pre-post) - On RAW functions
  18  * mode (replace-pre-post)
  19  * dir (replace-pre-post)
  20  * write (pre-post)
  21  * use-mmaped (replace-pre-post)
  22
  23 ### I2C
  24  * init (pre-post) - On RAW