module.h 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576
  1. /*
  2. ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio.
  3. This file is part of ChibiOS.
  4. ChibiOS is free software; you can redistribute it and/or modify
  5. it under the terms of the GNU General Public License as published by
  6. the Free Software Foundation; either version 3 of the License, or
  7. (at your option) any later version.
  8. ChibiOS is distributed in the hope that it will be useful,
  9. but WITHOUT ANY WARRANTY; without even the implied warranty of
  10. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11. GNU General Public License for more details.
  12. You should have received a copy of the GNU General Public License
  13. along with this program. If not, see <http://www.gnu.org/licenses/>.
  14. */
  15. /**
  16. * @file chXxx.h
  17. * @brief XXX Module macros and structures.
  18. *
  19. * @addtogroup XXX
  20. * @{
  21. */
  22. #ifndef CHXXX_H
  23. #define CHXXX_H
  24. #include "ch.h"
  25. #if CH_CFG_USE_XXX || defined(__DOXYGEN__)
  26. /*===========================================================================*/
  27. /* Module constants. */
  28. /*===========================================================================*/
  29. /*===========================================================================*/
  30. /* Module pre-compile time settings. */
  31. /*===========================================================================*/
  32. /*===========================================================================*/
  33. /* Derived constants and error checks. */
  34. /*===========================================================================*/
  35. /*===========================================================================*/
  36. /* Module data structures and types. */
  37. /*===========================================================================*/
  38. /*===========================================================================*/
  39. /* Module macros. */
  40. /*===========================================================================*/
  41. /*===========================================================================*/
  42. /* External declarations. */
  43. /*===========================================================================*/
  44. #ifdef __cplusplus
  45. extern "C" {
  46. #endif
  47. void chXxxInit(void);
  48. void chXxxObjectInit(xxx_t *xxxp);
  49. #ifdef __cplusplus
  50. }
  51. #endif
  52. /*===========================================================================*/
  53. /* Module inline functions. */
  54. /*===========================================================================*/
  55. #endif /* CH_CFG_USE_XXX */
  56. #endif /* CHXXX_H */
  57. /** @} */