syslog_console.h 3.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. /****************************************************************************
  2. * include/nuttx/syslog/syslog_console.h
  3. *
  4. * Copyright (C) 2015 Pierre-noel Bouteville. All rights reserved.
  5. * Author: Pierre-noel Bouteville <pnb990@gmail.com>
  6. *
  7. * Redistribution and use in source and binary forms, with or without
  8. * modification, are permitted provided that the following conditions
  9. * are met:
  10. *
  11. * 1. Redistributions of source code must retain the above copyright
  12. * notice, this list of conditions and the following disclaimer.
  13. * 2. Redistributions in binary form must reproduce the above copyright
  14. * notice, this list of conditions and the following disclaimer in
  15. * the documentation and/or other materials provided with the
  16. * distribution.
  17. * 3. Neither the name NuttX nor the names of its contributors may be
  18. * used to endorse or promote products derived from this software
  19. * without specific prior written permission.
  20. *
  21. * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22. * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23. * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  24. * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
  25. * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
  26. * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
  27. * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
  28. * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
  29. * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  30. * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  31. * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  32. * POSSIBILITY OF SUCH DAMAGE.
  33. *
  34. ****************************************************************************/
  35. #ifndef __INCLUDE_NUTTX_SYSLOG_SYSLOG_CONSOLE_H
  36. #define __INCLUDE_NUTTX_SYSLOG_SYSLOG_CONSOLE_H
  37. /****************************************************************************
  38. * Included Files
  39. ****************************************************************************/
  40. #include <nuttx/config.h>
  41. #include <nuttx/syslog/syslog.h>
  42. #ifdef CONFIG_CONSOLE_SYSLOG
  43. /****************************************************************************
  44. * Pre-processor Definitions
  45. ****************************************************************************/
  46. /* Configuration ************************************************************/
  47. /* CONFIG_CONSOLE_SYSLOG - Use the syslog logging output as a system console.
  48. * If this feature is enabled (along with CONFIG_DEV_CONSOLE), then all
  49. * console output will be re-directed to the SYSLOG output channel. This
  50. * is useful, for example, if the only console is a Telnet console. Then
  51. * in that case, console output from non-Telnet threads will go to the
  52. * SYSLOG output channel.
  53. */
  54. #ifndef CONFIG_DEV_CONSOLE
  55. # undef CONFIG_CONSOLE_SYSLOG
  56. #endif
  57. /****************************************************************************
  58. * Public Data
  59. ****************************************************************************/
  60. #ifndef __ASSEMBLY__
  61. #ifdef __cplusplus
  62. #define EXTERN extern "C"
  63. extern "C"
  64. {
  65. #else
  66. #define EXTERN extern
  67. #endif
  68. /****************************************************************************
  69. * Public Function Prototypes
  70. ****************************************************************************/
  71. /****************************************************************************
  72. * Name: syslog_console_init
  73. *
  74. * Description:
  75. * Create the console logging device and register it at the '/dev/console'
  76. * path.
  77. *
  78. ****************************************************************************/
  79. #ifdef CONFIG_CONSOLE_SYSLOG
  80. int syslog_console_init(void);
  81. #endif
  82. #undef EXTERN
  83. #ifdef __cplusplus
  84. }
  85. #endif
  86. #endif /* __ASSEMBLY__ */
  87. #endif /* CONFIG_CONSOLE_SYSLOG */
  88. #endif /* __INCLUDE_NUTTX_SYSLOG_SYSLOG_CONSOLE_H */