incubator-nuttx/drivers/syslog/syslog_consolechannel.c

105 lines
3.6 KiB
C

/****************************************************************************
* drivers/syslog/syslog_consolechannel.c
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/stat.h>
#include <fcntl.h>
#include <errno.h>
#include <nuttx/syslog/syslog.h>
#include "syslog.h"
#ifdef CONFIG_SYSLOG_CONSOLE
/****************************************************************************
* Pre-processor Definitions
****************************************************************************/
#define OPEN_FLAGS (O_WRONLY)
#define OPEN_MODE (S_IROTH | S_IRGRP | S_IRUSR | S_IWUSR)
/****************************************************************************
* Private Data
****************************************************************************/
/* Handle to the SYSLOG channel */
FAR static struct syslog_channel_s *g_syslog_console_channel;
/****************************************************************************
* 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:
* A pointer to the new SYSLOG channel; NULL is returned on any failure.
*
****************************************************************************/
FAR struct syslog_channel_s *syslog_console_channel(void)
{
/* Initialize the character driver interface */
g_syslog_console_channel = syslog_dev_initialize("/dev/console",
OPEN_FLAGS, OPEN_MODE);
if (g_syslog_console_channel == NULL)
{
return NULL;
}
/* Use the character driver as the SYSLOG channel */
if (syslog_channel(g_syslog_console_channel) != OK)
{
syslog_dev_uninitialize(g_syslog_console_channel);
g_syslog_console_channel = NULL;
}
return g_syslog_console_channel;
}
#endif /* CONFIG_SYSLOG_CONSOLE */