Google Git
Sign in
android / platform / system / tools / hidl / 796bd87cd116b839d773bf6def1fb9c1e2001ea5
commit796bd87cd116b839d773bf6def1fb9c1e2001ea5[log] [tgz]
authorSteven Moreland <smoreland@google.com>Wed Apr 11 11:20:55 2018 -0700
committerSteven Moreland <smoreland@google.com>Wed Apr 11 11:23:32 2018 -0700
tree40a0480a9dd5f7fbc11a911fb47f4e3e0adec98d
parent1a92c58a1ca05a62c45d7e217da14f60667cb6f7 [diff]
Update README.md

This README has gotten a little bit out of date.

- add link to actual external documentation
- remove references to croot
- provide examples using default package root
- provide example vendor command
- short summary of c2hal
- short summary of hidl-doc

Bug: N/A
Test: N/A
Change-Id: I86593363b99e14ba637824bd30cf324bf4d3273f
1 file changed
tree: 40a0480a9dd5f7fbc11a911fb47f4e3e0adec98d
  1. build/
  2. c2hal/
  3. docs/
  4. include_hash/
  5. test/
  6. utils/
  7. .clang-format
  8. Android.bp
  9. Annotation.cpp
  10. Annotation.h
  11. ArrayType.cpp
  12. ArrayType.h
  13. AST.cpp
  14. AST.h
  15. CleanSpec.mk
  16. CompoundType.cpp
  17. CompoundType.h
  18. ConstantExpression.cpp
  19. ConstantExpression.h
  20. Coordinator.cpp
  21. Coordinator.h
  22. DeathRecipientType.cpp
  23. DeathRecipientType.h
  24. EnumType.cpp
  25. EnumType.h
  26. FmqType.cpp
  27. FmqType.h
  28. generateCpp.cpp
  29. generateCppAdapter.cpp
  30. generateCppImpl.cpp
  31. generateJava.cpp
  32. generateVts.cpp
  33. HandleType.cpp
  34. HandleType.h
  35. Hash.cpp
  36. hidl-gen_l.h
  37. hidl-gen_l.ll
  38. hidl-gen_y.yy
  39. HidlTypeAssertion.cpp
  40. HidlTypeAssertion.h
  41. Interface.cpp
  42. Interface.h
  43. Location.cpp
  44. Location.h
  45. main.cpp
  46. MemoryType.cpp
  47. MemoryType.h
  48. Method.cpp
  49. Method.h
  50. MODULE_LICENSE_APACHE2
  51. NamedType.cpp
  52. NamedType.h
  53. NOTICE
  54. OWNERS
  55. PointerType.cpp
  56. PointerType.h
  57. PREUPLOAD.cfg
  58. README.md
  59. Reference.h
  60. RefType.cpp
  61. RefType.h
  62. ScalarType.cpp
  63. ScalarType.h
  64. Scope.cpp
  65. Scope.h
  66. StringType.cpp
  67. StringType.h
  68. Type.cpp
  69. Type.h
  70. TypeDef.cpp
  71. TypeDef.h
  72. update-all-google-makefiles.sh
  73. update-makefiles-helper.sh
  74. VectorType.cpp
  75. VectorType.h
README.md

hidl-gen

Full documentation can be found here: https://source.android.com/devices/architecture/hidl/

hidl-gen is a compiler for the HIDL (HAL Interface Design Language) which generates C++ and Java endpoints for RPC mechanisms. The main userspace libraries which this compiler uses can be found at system/libhidl.

1. Build

m hidl-gen

2. Run

Note that options for hidl-gen expected to be invoked by the build system are marked with ‘internal’ in the help menu.

hidl-gen -h

hidl-gen -o output -L c++-impl -r android.hardware:hardware/interfaces -r android.hidl:system/libhidl/transport android.hardware.nfc@1.0

Some defaults for package roots are also provided

hidl-gen -o output -L c++-impl android.hardware.nfc@1.0
hidl-gen -o output -L vts android.hardware.nfc@1.0
hidl-gen -L hash android.hardware.nfc@1.0

Example command for vendor project

hidl-gen -L c++-impl -r vendor.foo:vendor/foo/interfaces vendor.foo.nfc@1.0

See update-makefiles-helper.sh and update-all-google-makefiles.sh for examples of how to generate HIDL makefiles (using the -Landroidbp option).

c2hal

This is a helper tool to convert C headers to valid .hal files.

m c2hal && c2hal -h

docs

This tool generates html documentation for hal interfaces.

m hidl-doc && hidl-doc -h