Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / system / tools / hidl / 86167e9c46b121f4eb5155288c24f939ec095a40
commit86167e9c46b121f4eb5155288c24f939ec095a40[log] [tgz]
authorSteven Moreland <smoreland@google.com>Thu Jun 20 13:18:47 2019 -0700
committerSteven Moreland <smoreland@google.com>Thu Jun 20 13:22:06 2019 -0700
treed3a2fcef7193265d6cedf1e29e2e3a629ad41034
parent6448d01bcc0addbeb01d3e565c24283b4a178344 [diff]
Remove hidl-doc.

This no longer works on all interfaces (no safe_union support) and
future/existing efforts are focusing on making the hidl-gen output
itself more usable for existing tools.

For instance, here are some of the things being done or which have
already been done:
- copy comments from HIDL files to their generated outputs
- adding comments to HIDL-generated code

Using these mechanisms, we may consider something like doxygen (or just
increased usages of tools in the tree that directly look at the
generated files, e.g. using compdb, AIDEgen, or other technologies).

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