/****************************************************************************
* arch/z16/src/z16f/z16f_serial.c
*
* Copyright (C) 2008 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
*
* 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/types.h>
#include <unistd.h>
#include <semaphore.h>
#include <string.h>
#include <errno.h>
#include <debug.h>
#include <nuttx/irq.h>
#include <nuttx/arch.h>
#include <nuttx/serial.h>
#include <arch/serial.h>
#include "chip/chip.h"
#include "os_internal.h"
#include "up_internal.h"
#if CONFIG_NFILE_DESCRIPTORS > 0
/****************************************************************************
* Definitions
****************************************************************************/
#define BASE_BAUD 115200
/* System clock frequency value from ZDS target settings */
extern _Erom unsigned long SYS_CLK_FREQ;
#define _DEFCLK ((unsigned long)&SYS_CLK_FREQ)
/****************************************************************************
* Private Types
****************************************************************************/
struct z16f_uart_s
{
uint32 uartbase; /* Base address of UART
* registers */
uint32 baud; /* Configured baud */
boolean rxenabled; /* RX interrupt enabled */
boolean txenabled; /* TX interrupt enabled */
ubyte rxirq; /* RX IRQ associated with this UART */
ubyte txirq; /* RX IRQ associated with this UART */
ubyte parity; /* 0=none, 1=odd, 2=even */
boolean stopbits2; /* TRUE: Configure with 2
* stop bits instead of 1 */
};
/****************************************************************************
* Private Function Prototypes
****************************************************************************/
static int z16f_setup(struct uart_dev_s *dev);
static void z16f_shutdown(struct uart_dev_s *dev);
static int z16f_attach(struct uart_dev_s *dev);
static void z16f_detach(struct uart_dev_s *dev);
static int z16f_rxinterrupt(int irq, void *context);
static int z16f_txinterrupt(int irq, void *context);
static int z16f_ioctl(struct file *filep, int cmd, unsigned long arg);
static int z16f_receive(struct uart_dev_s *dev, uint32 *status);
static void z16f_rxint(struct uart_dev_s *dev, boolean enable);
static boolean z16f_rxavailable(struct uart_dev_s *dev);
static void z16f_send(struct uart_dev_s *dev, int ch);
static void z16f_txint(struct uart_dev_s *dev, boolean enable);
static boolean z16f_txready(struct uart_dev_s *dev);
static boolean z16f_txempty(struct uart_dev_s *dev);
/****************************************************************************
* Private Variables
****************************************************************************/
struct uart_ops_s g_uart_ops =
{
z16f_setup, /* setup */
z16f_shutdown, /* shutdown */
z16f_attach, /* attach */
z16f_detach, /* detach */
z16f_ioctl, /* ioctl */
z16f_receive, /* receive */
z16f_rxint, /* rxint */
z16f_rxavailable, /* rxavailable */
z16f_send, /* send */
z16f_txint, /* txint */
z16f_txready, /* txready */
z16f_txempty /* txempty */
};
/* I/O buffers */
static char g_uart0rxbuffer[CONFIG_UART0_RXBUFSIZE];
static char g_uart0txbuffer[CONFIG_UART0_TXBUFSIZE];
static char g_uart1rxbuffer[CONFIG_UART1_RXBUFSIZE];
static char g_uart1txbuffer[CONFIG_UART1_TXBUFSIZE];
/* This describes the state of the DM320 uart0 port. */
static struct z16f_uart_s g_uart0priv =
{
Z16F_UART0_BASE, /* uartbase */
CONFIG_UART0_BAUD, /* baud */
FALSE, /* rxenabled */
FALSE, /* txenabled */
Z16F_IRQ_UART0TX, /* txirq */
Z16F_IRQ_UART0RX, /* rxirq */
CONFIG_UART0_PARITY, /* parity */
CONFIG_UART0_2STOP /* stopbits2 */
};
static uart_dev_t g_uart0port =
{
0, /* open_count */
FALSE, /* xmitwaiting */
FALSE, /* recvwaiting */
#ifdef CONFIG_UART0_SERIAL_CONSOLE
TRUE, /* isconsole */
#else
FALSE, /* isconsole */
#endif
{ 0 }, /* closesem */
{ 0 }, /* xmitsem */
{ 0 }, /* recvsem */
{
{ 0 }, /* xmit.sem */
0, /* xmit.head */
0, /* xmit.tail */
CONFIG_UART0_TXBUFSIZE, /* xmit.size */
g_uart0txbuffer, /* xmit.buffer */
},
{
{ 0 }, /* recv.sem */
0, /* recv.head */
0, /* recv.tail */
CONFIG_UART0_RXBUFSIZE, /* recv.size */
g_uart0rxbuffer, /* recv.buffer */
},
&g_uart_ops, /* ops */
&g_uart0priv, /* priv */
};
/* This describes the state of the DM320 uart1 port. */
static struct z16f_uart_s g_uart1priv =
{
Z16F_UART1_BASE, /* uartbase */
CONFIG_UART1_BAUD, /* baud */
FALSE, /* rxenabled */
FALSE, /* txenabled */
Z16F_IRQ_UART1TX, /* txirq */
Z16F_IRQ_UART1RX, /* rxirq */
CONFIG_UART1_PARITY, /* parity */
CONFIG_UART1_2STOP /* stopbits2 */
};
static uart_dev_t g_uart1port =
{
0, /* open_count */
FALSE, /* xmitwaiting */
FALSE, /* recvwaiting */
#ifdef CONFIG_UART1_SERIAL_CONSOLE
TRUE, /* isconsole */
#else
FALSE, /* isconsole */
#endif
{ 0 }, /* closesem */
{ 0 }, /* xmitsem */
{ 0 }, /* recvsem */
{
{ 0 }, /* xmit.sem */
0, /* xmit.head */
0, /* xmit.tail */
CONFIG_UART1_TXBUFSIZE, /* xmit.size */
g_uart1txbuffer, /* xmit.buffer */
},
{
{ 0 }, /* recv.sem */
0, /* recv.head */
0, /* recv.tail */
CONFIG_UART0_RXBUFSIZE, /* recv.size */
g_uart0rxbuffer, /* recv.buffer */
},
&g_uart_ops, /* ops */
&g_uart1priv, /* priv */
};
/* Now, which one with be tty0/console and which tty1? */
#ifdef CONFIG_UART1_SERIAL_CONSOLE
# define CONSOLE_DEV g_uart1port
# define TTYS0_DEV g_uart1port
# define TTYS1_DEV g_uart0port
#else
# define CONSOLE_DEV g_uart0port
# define TTYS0_DEV g_uart0port
# define TTYS1_DEV g_uart1port
#endif
/****************************************************************************
* Private Functions
****************************************************************************/
/****************************************************************************
* Name: z16f_disableuartirq
****************************************************************************/
static ubyte z16f_disableuartirq(struct uart_dev_s *dev)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
irqstate_t flags = irqsave();
ubyte state = priv->rxenabled ? 1 : 0 | priv->txenabled ? 2 : 0;
z16f_txint(dev, FALSE);
z16f_rxint(dev, FALSE);
irqrestore(flags);
return state;
}
/****************************************************************************
* Name: z16f_restoreuartirq
****************************************************************************/
static void z16f_restoreuartirq(struct uart_dev_s *dev, ubyte state)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
irqstate_t flags = irqsave();
z16f_txint(dev, (state & 2) ? TRUE : FALSE);
z16f_rxint(dev, (state & 1) ? TRUE : FALSE);
irqrestore(flags);
}
/****************************************************************************
* Name: z16f_waittx
****************************************************************************/
static void z16f_waittx(struct uart_dev_s *dev, boolean (*status)(struct uart_dev_s *))
{
int tmp;
for (tmp = 1000 ; tmp > 0 ; tmp--)
{
if (status(dev))
{
break;
}
}
}
/****************************************************************************
* Name: z16f_setup
*
* Description:
* Configure the UART baud, parity, etc. This method is called the first
* time that the serial port is opened.
*
****************************************************************************/
static int z16f_setup(struct uart_dev_s *dev)
{
#ifndef CONFIG_SUPPRESS_UART_CONFIG
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
uint32 brg;
ubyte ctl0;
ubyte ctl1;
/* Calculate and set the baud rate generation register.
* BRG = (freq + baud * 8)/(baud * 16)
*/
brg = (_DEFCLK + (priv->baud << 3))/(priv->baud << 4);
putreg16((uint16)brg, priv->uartbase + Z16F_UART_BR);
/* Configure STOP bits */
ctl0 = ctl1 = 0;
if (priv->stopbits2)
{
ctl0 |= Z16F_UARTCTL0_STOP;
}
/* Configure parity */
if (priv->parity == 1)
{
ctl0 |= (Z16F_UARTCTL0_PEN|Z16F_UARTCTL0_PSEL);
}
else if (priv->parity == 2)
{
ctl0 |= Z16F_UARTCTL0_PEN;
}
putreg8(ctl0, priv->uartbase + Z16F_UART_CTL0);
putreg8(ctl1, priv->uartbase + Z16F_UART_CTL1);
/* Enable UART receive (REN) and transmit (TEN) */
ctl0 |= (Z16F_UARTCTL0_TEN|Z16F_UARTCTL0_REN);
putreg8(ctl0, priv->uartbase + Z16F_UART_CTL0);
#endif
return OK;
}
/****************************************************************************
* Name: z16f_shutdown
*
* Description:
* Disable the UART. This method is called when the serial
* port is closed
*
****************************************************************************/
static void z16f_shutdown(struct uart_dev_s *dev)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
(void)z16f_disableuartirq(dev);
}
/****************************************************************************
* Name: z16f_attach
*
* Description:
* Configure the UART to operation in interrupt driven mode. This method is
* called when the serial port is opened. Normally, this is just after the
* the setup() method is called, however, the serial console may operate in
* a non-interrupt driven mode during the boot phase.
*
* RX and TX interrupts are not enabled when by the attach method (unless the
* hardware supports multiple levels of interrupt enabling). The RX and TX
* interrupts are not enabled until the txint() and rxint() methods are called.
*
****************************************************************************/
static int z16f_attach(struct uart_dev_s *dev)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
int ret;
/* Attach the RX IRQ */
ret = irq_attach(priv->rxirq, z16f_rxinterrupt);
if (ret != OK)
{
goto errout;
}
/* Attach the TX IRQ */
ret = irq_attach(priv->txirq, z16f_txinterrupt);
if (ret != OK)
{
goto errout_with_rxirq;
}
return OK;
errout_with_rxirq:
irq_detach(priv->rxirq);
errout:
return ret;
}
/****************************************************************************
* Name: z16f_detach
*
* Description:
* Detach UART interrupts. This method is called when the serial port is
* closed normally just before the shutdown method is called. The exception is
* the serial console which is never shutdown.
*
****************************************************************************/
static void z16f_detach(struct uart_dev_s *dev)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
up_disable_irq(priv->rxirq);
up_disable_irq(priv->txirq);
irq_detach(priv->rxirq);
irq_detach(priv->txirq);
}
/****************************************************************************
* Name: z16f_rxinterrupt
*
* Description:
* This is the UART interrupt handler. It will be invoked when an RX
* event occurs at the Z16F's LIN-UART.
*
****************************************************************************/
static int z16f_rxinterrupt(int irq, void *context)
{
struct uart_dev_s *dev = NULL;
struct z16f_uart_s *priv;
ubyte status;
if (g_uart1priv.rxirq == irq)
{
dev = &g_uart1port;
}
else if (g_uart0priv.rxirq == irq)
{
dev = &g_uart0port;
}
else
{
PANIC(OSERR_INTERNAL);
}
priv = (struct z16f_uart_s*)dev->priv;
/* Check the LIN-UART status 0 register to determine whether the source of
* the interrupt is error, break, or received data
*/
status = getreg8(priv->uartbase + Z16F_UART_STAT0);
/* REVISIT error and break handling */
/* Check if received data is available */
if (status & Z16F_UARTSTAT0_RDA)
{
/* Handline an incoming, receive byte */
uart_recvchars(dev);
}
return OK;
}
/****************************************************************************
* Name: z16f_txinterrupt
*
* Description:
* This is the UART TX interrupt handler. This interrupt handler will
* be invoked when the X16F LIN UART transmit data register is empty.
*
****************************************************************************/
static int z16f_txinterrupt(int irq, void *context)
{
struct uart_dev_s *dev = NULL;
struct z16f_uart_s *priv;
ubyte status;
if (g_uart1priv.txirq == irq)
{
dev = &g_uart1port;
}
else if (g_uart0priv.txirq == irq)
{
dev = &g_uart0port;
}
else
{
PANIC(OSERR_INTERNAL);
}
priv = (struct z16f_uart_s*)dev->priv;
/* Verify that the transmit data register is empty */
status = getreg8(priv->uartbase + Z16F_UART_STAT0);
if (status & Z16F_UARTSTAT0_TDRE)
{
/* Handle outgoing, transmit bytes */
uart_xmitchars(dev);
}
return OK;
}
/****************************************************************************
* Name: z16f_ioctl
*
* Description:
* All ioctl calls will be routed through this method
*
****************************************************************************/
static int z16f_ioctl(struct file *filep, int cmd, unsigned long arg)
{
*get_errno_ptr() = ENOTTY;
return ERROR;
}
/****************************************************************************
* Name: z16f_receive
*
* Description:
* Called (usually) from the interrupt level to receive one character from
* the UART. Error bits associated with the receipt are provided in the
* return 'status'.
*
****************************************************************************/
static int z16f_receive(struct uart_dev_s *dev, uint32 *status)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
ubyte rxd;
ubyte stat0;
rxd = getreg8(priv->uartbase + Z16F_UART_RXD);
stat0 = getreg8(priv->uartbase + Z16F_UART_STAT0);
*status = (uint32)rxd | (((uint32)stat0) << 8);
return rxd;
}
/****************************************************************************
* Name: z16f_rxint
*
* Description:
* Call to enable or disable RX interrupts
*
****************************************************************************/
static void z16f_rxint(struct uart_dev_s *dev, boolean enable)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
irqstate_t flags = irqsave();
if (enable)
{
#ifndef CONFIG_SUPPRESS_SERIAL_INTS
up_enable_irq(priv->rxirq);
#endif
}
else
{
up_disable_irq(priv->rxirq);
}
priv->rxenabled = enable;
irqrestore(flags);
}
/****************************************************************************
* Name: z16f_rxavailable
*
* Description:
* Return TRUE if the receive fifo is not empty
*
****************************************************************************/
static boolean z16f_rxavailable(struct uart_dev_s *dev)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
return ((getreg8(priv->uartbase + Z16F_UART_STAT0) & Z16F_UARTSTAT0_RDA) != 0);
}
/****************************************************************************
* Name: z16f_send
*
* Description:
* This method will send one byte on the UART
*
****************************************************************************/
static void z16f_send(struct uart_dev_s *dev, int ch)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
putreg8(ch, priv->uartbase + Z16F_UART1_TXD);
}
/****************************************************************************
* Name: z16f_txint
*
* Description:
* Call to enable or disable TX interrupts
*
****************************************************************************/
static void z16f_txint(struct uart_dev_s *dev, boolean enable)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
irqstate_t flags = irqsave();
if (enable)
{
#ifndef CONFIG_SUPPRESS_SERIAL_INTS
up_enable_irq(priv->txirq);
#endif
}
else
{
up_disable_irq(priv->txirq);
}
priv->txenabled = enable;
irqrestore(flags);
}
/****************************************************************************
* Name: z16f_txready
*
* Description:
* Return TRUE if the tranmsit fifo is not full
*
****************************************************************************/
static boolean z16f_txready(struct uart_dev_s *dev)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
return ((getreg8(priv->uartbase + Z16F_UART_STAT0) & Z16F_UARTSTAT0_TDRE) != 0);
}
/****************************************************************************
* Name: z16f_txempty
*
* Description:
* Return TRUE if the transmit fifo is empty
*
****************************************************************************/
static boolean z16f_txempty(struct uart_dev_s *dev)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)dev->priv;
return ((getreg8(priv->uartbase + Z16F_UART_STAT0) & Z16F_UARTSTAT0_TXE) != 0);
}
/****************************************************************************
* Public Funtions
****************************************************************************/
/****************************************************************************
* Name: up_earlyserialinit
*
* Description:
* Performs the low level UART initialization early in
* debug so that the serial console will be available
* during bootup. This must be called before z16f_serialinit.
*
****************************************************************************/
void up_earlyserialinit(void)
{
(void)z16f_disableuartirq(&TTYS0_DEV);
(void)z16f_disableuartirq(&TTYS1_DEV);
CONSOLE_DEV.isconsole = TRUE;
z16f_setup(&CONSOLE_DEV);
}
/****************************************************************************
* Name: up_serialinit
*
* Description:
* Register serial console and serial ports. This assumes
* that up_earlyserialinit was called previously.
*
****************************************************************************/
void up_serialinit(void)
{
(void)uart_register("/dev/console", &CONSOLE_DEV);
(void)uart_register("/dev/ttyS0", &TTYS0_DEV);
(void)uart_register("/dev/ttyS1", &TTYS1_DEV);
}
/****************************************************************************
* Name: up_putc
*
* Description:
* Provide priority, low-level access to support OS debug
* writes
*
****************************************************************************/
int up_putc(int ch)
{
struct z16f_uart_s *priv = (struct z16f_uart_s*)CONSOLE_DEV.priv;
ubyte state;
/* Keep interrupts disabled so that we do not interfere with normal
* driver operation
*/
state = z16f_disableuartirq(&CONSOLE_DEV);
/* Check for LF */
if (ch == '\n')
{
/* Add CR before LF */
z16f_waittx(&CONSOLE_DEV, z16f_txready);
putreg8('\r', priv->uartbase + Z16F_UART_TXD);
}
/* Output the character */
z16f_waittx(&CONSOLE_DEV, z16f_txready);
putreg8((ubyte)ch, priv->uartbase + Z16F_UART_TXD);
/* Now wait for all queue TX data to drain before restoring interrupts. The
* driver should receive one txdone interrupt which it may or may not ignore.
*/
z16f_waittx(&CONSOLE_DEV, z16f_txempty);
z16f_restoreuartirq(&CONSOLE_DEV, state);
return ch;
}
#else /* CONFIG_NFILE_DESCRIPTORS > 0 */
/****************************************************************************
* Definitions
****************************************************************************/
#ifdef CONFIG_UART1_SERIAL_CONSOLE
# define z16f_contrde() \
((getreg8(Z16F_UART1_STAT0) & Z16F_UARTSTAT0_TDRE) != 0)
# define z16f_contxd(ch) \
putreg8((ubyte)(ch), Z16F_UART1_TXD)
#else
# define z16f_contrde() \
((getreg8(Z16F_UART0_STAT0) & Z16F_UARTSTAT0_TDRE) != 0)
# define z16f_contxd(ch) \
putreg8((ubyte)(ch), Z16F_UART0_TXD)
#endif
/****************************************************************************
* Private Functions
****************************************************************************/
static void _up_putc(int ch)
{
int tmp;
for (tmp = 1000 ; tmp > 0 && !z16f_contrde(); tmp--);
z16f_contxd(ch);
}
/****************************************************************************
* Public Functions
****************************************************************************/
int up_putc(int ch)
{
/* Check for LF */
if (ch == '\n')
{
/* Output CR before LF */
_up_putc('\r');
}
/* Output character */
_up_putc(ch);
return ch;
}
#endif /* CONFIG_NFILE_DESCRIPTORS > 0 */
