incubator-nuttx/drivers/syslog/syslog_consolechannel.c

163 lines
5.4 KiB
C

/****************************************************************************
* drivers/syslog/syslog_consolechannel.c
*
* Copyright (C) 2016 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name NuttX nor the names of its contributors may be
* used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
* COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
* ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <nuttx/arch.h>
#include <nuttx/syslog/syslog.h>
#include "syslog.h"
#ifdef CONFIG_SYSLOG_CONSOLE
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#undef HAVE_LOWPUTC
#if defined(CONFIG_SYSLOG_SERIAL_CONSOLE) && defined(CONFIG_ARCH_LOWPUTC)
# define HAVE_LOWPUTC 1
#endif
#define OPEN_FLAGS (O_WRONLY)
#define OPEN_MODE (S_IROTH | S_IRGRP | S_IRUSR | S_IWUSR)
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
/* SYSLOG channel methods */
#ifndef HAVE_LOWPUTC
static int syslog_console_force(int ch);
#endif
/****************************************************************************
* Private Data
****************************************************************************/
/* This structure describes the SYSLOG channel */
static const struct syslog_channel_s g_syslog_console_channel =
{
syslog_dev_putc,
#ifdef HAVE_LOWPUTC
up_putc,
#else
syslog_console_force,
#endif
syslog_dev_flush,
};
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: syslog_console_force
*
* Description:
* A dummy FORCE method
*
****************************************************************************/
#ifndef HAVE_LOWPUTC
static int syslog_console_force(int ch)
{
return ch;
}
#endif
/****************************************************************************
* Public Functions
****************************************************************************/
/****************************************************************************
* Name: syslog_console_channel
*
* Description:
* Configure to use the character device (or file) at /dev/console as the
* SYSLOG channel.
*
* This tiny function is simply a wrapper around syslog_dev_initialize()
* and syslog_channel(). It calls syslog_dev_initialize() to configure
* the character device at /dev/console then calls syslog_channel() to
* use that device as the SYSLOG output channel.
*
* NOTE interrupt level SYSLOG output will be lost in the general case
* unless the interrupt buffer is used. As a special case: If the serial
* console is used and the architecture provides up_putc(), the interrupt
* level output will be directed to up_putc() is the interrupt buffer is
* disabled.
*
* Input Parameters:
* None
*
* Returned Value:
* Zero (OK) is returned on success; a negated errno value is returned on
* any failure.
*
****************************************************************************/
int syslog_console_channel(void)
{
int ret;
/* Initialize the character driver interface */
ret = syslog_dev_initialize("/dev/console", OPEN_FLAGS, OPEN_MODE);
if (ret < 0)
{
return ret;
}
/* Use the character driver as the SYSLOG channel */
return syslog_channel(&g_syslog_console_channel);
}
#endif /* CONFIG_SYSLOG_CONSOLE */