Fix two errors introduced by previous commit.
[bertos.git] / drv / ser_avr.c
index 9e417cc9b40b4e8b95cfef96b8ff1b2827809e62..356c1588e2cca445116a5a6d4784b7645c4dffed 100755 (executable)
@@ -6,15 +6,46 @@
  * This file is part of DevLib - See devlib/README for information.
  * -->
  *
- * \version $Id$
+ * \brief AVR UART and SPI I/O driver
  *
- * \author Bernardo Innocenti <bernie@develer.com>
+ * Rationale for project_ks hardware.
  *
- * \brief AVR UART and SPI I/O driver
+ * The serial 0 on the board_kf board is used to communicate with the
+ * smart card, which has the TX and RX lines connected together. To
+ * allow the smart card to drive the RX line of the CPU the CPU TX has
+ * to be in a high impedance state.
+ * Whenever a transmission is done and there is nothing more to send
+ * the transmitter is turn off. The output pin is held in input with
+ * pull-up enabled, to avoid capturing noise from the nearby RX line.
+ *
+ * The line on the KBus port must keep sending data, even when
+ * there is nothing to transmit, because a burst data transfer
+ * generates noise on the audio channels.
+ * This is accomplished using the multiprocessor mode of the
+ * ATmega64/128 serial.
+ *
+ * The receiver keeps the MPCM bit always on. When useful data
+ * is trasmitted the address bit is set. The receiver hardware
+ * consider the frame as address info and receive it.
+ * When useless fill bytes are sent the address bit is cleared
+ * and the receiver will ignore them, avoiding useless triggering
+ * of RXC interrupt.
+ *
+ * \version $Id$
+ * \author Bernardo Innocenti <bernie@develer.com>
  */
 
 /*
  * $Log$
+ * Revision 1.7  2004/07/18 21:54:23  bernie
+ * Add ATmega8 support.
+ *
+ * Revision 1.5  2004/06/27 15:25:40  aleph
+ * Add missing callbacks for SPI;
+ * Change UNUSED() macro to new version with two args;
+ * Use TX line filling only on the correct KBUS serial port;
+ * Fix nasty IRQ disabling bug in recv complete hander for port 1.
+ *
  * Revision 1.4  2004/06/03 11:27:09  bernie
  * Add dual-license information.
  *
@@ -33,6 +64,9 @@
 #include "hw.h"
 #include <mware/fifobuf.h>
 
+#include <avr/signal.h>
+
+
 extern struct Serial ser_handles[SER_CNT];
 
 struct AvrSerial
@@ -57,16 +91,27 @@ struct AvrSerial
 #define SPI_MISO_BIT  PORTB3
 
 
-#ifdef __AVR_ATmega103__
+#if defined(__AVR_ATmega64__) || defined(__AVR_ATmega128__)
+       #define AVR_HAS_UART1
+#elif defined(__AVR_ATmega8__)
+       #define UCSR0A UCSRA
+       #define UCSR0B UCSRB
+       #define UCSR0C UCSRC
+       #define UDR0   UDR
+       #define UBRR0L UBRRL
+       #define UBRR0H UBRRH
+       #define SIG_UART0_DATA SIG_UART_DATA
+       #define SIG_UART0_RECV SIG_UART_RECV
+#elif defined(__AVR_ATmega103__)
        /* Macro for ATmega103 compatibility */
        #define UCSR0B UCR
        #define UDR0   UDR
        #define UCSR0A USR
        #define UBRR0L UBRR
+       #define SIG_UART0_DATA SIG_UART_DATA
+       #define SIG_UART0_RECV SIG_UART_RECV
 #else
-       #define UCR  UCSR0B
-       #define UDR  UDR0
-       #define USR  UCSR0A
+       #error Unknown architecture
 #endif
 
 
@@ -74,9 +119,9 @@ struct AvrSerial
 #define SER_FILL_BYTE 0xAA
 
 
-static void uart0_enabletxirq(UNUSED(struct SerialHardware *ctx))
+static void uart0_enabletxirq(UNUSED(struct SerialHardware *ctx))
 {
-#ifdef CONFIG_SER_TXFILL
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 0)
        UCSR0B = BV(RXCIE) | BV(UDRIE) | BV(RXEN) | BV(TXEN) | BV(UCSZ2);
 #else
        UCSR0B = BV(RXCIE) | BV(UDRIE) | BV(RXEN) | BV(TXEN);
@@ -88,24 +133,24 @@ static void uart0_init(struct SerialHardware *_hw, struct Serial *ser)
        struct AvrSerial *hw = (struct AvrSerial *)_hw;
        hw->serial = ser;
 
+#if defined(ARCH_BOARD_KS) && (ARCH & ARCH_BOARD_KS)
        /* Set TX port as input with pull-up enabled to avoid
-        * noise on the remote RX when TX is disabled */
+          noise on the remote RX when TX is disabled. */
        cpuflags_t flags;
        DISABLE_IRQSAVE(flags);
        DDRE &= ~BV(PORTE1);
        PORTE |= BV(PORTE1);
        ENABLE_IRQRESTORE(flags);
+#endif /* ARCH_BOARD_KS */
 
-       /* TODO: explain why TX is disabled whenever possible */
-#ifdef CONFIG_SER_TXFILL
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 0)
        /*!
         * Set multiprocessor mode and 9 bit data frame.
         * The receiver keep MPCM bit always on. When useful data
-        * is trasmitted the ninth bit is set. Receiver consider the
-        * frame as address info and receive it.
+        * is trasmitted the ninth bit is set and the receiver receive
+        * the frame.
         * When useless fill bytes are sent the ninth bit is cleared
-        * and the receiver will ignore them, avoiding useless triggering
-        * of RXC interrupt.
+        * and the receiver will ignore them.
         */
        UCSR0A = BV(MPCM);
        UCSR0B = BV(RXCIE) | BV(RXEN) | BV(UCSZ2);
@@ -116,15 +161,16 @@ static void uart0_init(struct SerialHardware *_hw, struct Serial *ser)
        RTS_ON;
 }
 
-static void uart0_cleanup(UNUSED(struct SerialHardware *ctx))
+static void uart0_cleanup(UNUSED(struct SerialHardware *ctx))
 {
        UCSR0B = 0;
 }
 
-static void uart0_setbaudrate(UNUSED(struct SerialHardware *ctx), unsigned long rate)
+static void uart0_setbaudrate(UNUSED(struct SerialHardware *ctx), unsigned long rate)
 {
-       // Compute baud-rate period
+       /* Compute baud-rate period */
        uint16_t period = (((CLOCK_FREQ / 16UL) + (rate / 2)) / rate) - 1;
+       DB(kprintf("uart0_setbaudrate(rate=%ld): period=%d\n", rate, period);)
 
 #ifndef __AVR_ATmega103__
        UBRR0H = (period) >> 8;
@@ -132,12 +178,22 @@ static void uart0_setbaudrate(UNUSED(struct SerialHardware *ctx), unsigned long
        UBRR0L = (period);
 }
 
-
+static void uart0_setparity(UNUSED(struct SerialHardware *, ctx), int parity)
+{
 #ifndef __AVR_ATmega103__
+       UCSR0C |= (parity) << UPM0;
+#endif
+}
+
+#ifdef AVR_HAS_UART1
 
-static void uart1_enabletxirq(UNUSED(struct SerialHardware *ctx))
+static void uart1_enabletxirq(UNUSED(struct SerialHardware *ctx))
 {
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 1)
+       UCSR1B = BV(RXCIE) | BV(UDRIE) | BV(RXEN) | BV(TXEN) | BV(UCSZ2);
+#else
        UCSR1B = BV(RXCIE) | BV(UDRIE) | BV(RXEN) | BV(TXEN);
+#endif
 }
 
 static void uart1_init(struct SerialHardware *_hw, struct Serial *ser)
@@ -153,37 +209,40 @@ static void uart1_init(struct SerialHardware *_hw, struct Serial *ser)
        PORTD |= BV(PORTD3);
        ENABLE_IRQRESTORE(flags);
 
-       /* TODO: explain why TX is disabled whenever possible */
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 1)
+       /*! See comment in uart0_init() */
+       UCSR1A = BV(MPCM);
+       UCSR1B = BV(RXCIE) | BV(RXEN) | BV(UCSZ2);
+#else
        UCSR1B = BV(RXCIE) | BV(RXEN);
+#endif
 
        RTS_ON;
 }
 
-static void uart1_cleanup(UNUSED(struct SerialHardware *ctx))
+static void uart1_cleanup(UNUSED(struct SerialHardware *ctx))
 {
        UCSR1B = 0;
 }
 
-static void uart1_setbaudrate(UNUSED(struct SerialHardware *ctx), unsigned long rate)
+static void uart1_setbaudrate(UNUSED(struct SerialHardware *ctx), unsigned long rate)
 {
-       // Compute baud-rate period
+       /* Compute baud-rate period */
        uint16_t period = (((CLOCK_FREQ / 16UL) + (rate / 2)) / rate) - 1;
+       DB(kprintf("uart1_setbaudrate(rate=%ld): period=%d\n", rate, period);)
 
        UBRR1H = (period) >> 8;
        UBRR1L = (period);
 }
 
-static void uart0_setparity(UNUSED(struct SerialHardware *ctx), int parity)
-{
-       UCSR0C |= (parity) << UPM0;
-}
-
-static void uart1_setparity(UNUSED(struct SerialHardware *ctx), int parity)
+static void uart1_setparity(UNUSED(struct SerialHardware *, ctx), int parity)
 {
+       // FIXME: move somewhere else
+       UCSR1C |= BV(USBS1); // 2 stop bits
        UCSR1C |= (parity) << UPM0;
 }
 
-#endif /* !__AVR_ATmega103__ */
+#endif // AVR_HAS_UART1
 
 
 static void spi_init(struct SerialHardware *_hw, struct Serial *ser)
@@ -191,20 +250,41 @@ static void spi_init(struct SerialHardware *_hw, struct Serial *ser)
        struct AvrSerial *hw = (struct AvrSerial *)_hw;
        hw->serial = ser;
 
-       /* MOSI and SCK out, MISO in */
+       /*
+        * Set MOSI and SCK ports out, MISO in.
+        *
+        * The ATmega64/128 datasheet explicitly states that the input/output
+        * state of the SPI pins is not significant, as when the SPI is
+        * active the I/O port are overrided.
+        * This is *blatantly FALSE*.
+        *
+        * Moreover the MISO pin on the board_kc *must* be in high impedance
+        * state even when the SPI is off, because the line is wired together
+        * with the KBus serial RX, and the transmitter of the slave boards
+        * could not be able to drive the line.
+        */
        SPI_DDR |= BV(SPI_MOSI_BIT) | BV(SPI_SCK_BIT);
        SPI_DDR &= ~BV(SPI_MISO_BIT);
        /* Enable SPI, IRQ on, Master, CPU_CLOCK/16 */
        SPCR = BV(SPE) | BV(SPIE) | BV(MSTR) | BV(SPR0);
 }
 
-static void spi_cleanup(UNUSED(struct SerialHardware *ctx))
+static void spi_cleanup(UNUSED(struct SerialHardware *ctx))
 {
        SPCR = 0;
        /* Set all pins as inputs */
        SPI_DDR &= ~(BV(SPI_MISO_BIT) | BV(SPI_MOSI_BIT) | BV(SPI_SCK_BIT));
 }
 
+static void spi_setbaudrate(UNUSED(struct SerialHardware *, ctx), UNUSED(unsigned long, rate))
+{
+       // Do nothing
+}
+
+static void spi_setparity(UNUSED(struct SerialHardware *, ctx), UNUSED(int, parity))
+{
+       // Do nothing
+}
 
 
 #if defined(CONFIG_SER_HW_HANDSHAKE)
@@ -213,7 +293,7 @@ static void spi_cleanup(UNUSED(struct SerialHardware *ctx))
 SIGNAL(SIG_CTS)
 {
        // Re-enable UDR empty interrupt and TX, then disable CTS interrupt
-       UCR = BV(RXCIE) | BV(UDRIE) | BV(RXEN) | BV(TXEN);
+       UCSR0B = BV(RXCIE) | BV(UDRIE) | BV(RXEN) | BV(TXEN);
        cbi(EIMSK, EIMSKB_CTS);
 }
 
@@ -223,15 +303,11 @@ SIGNAL(SIG_CTS)
 /*!
  * Serial 0 TX interrupt handler
  */
-#ifdef __AVR_ATmega103__
-SIGNAL(SIG_UART_DATA)
-#else
 SIGNAL(SIG_UART0_DATA)
-#endif
 {
        if (fifo_isempty(&ser_handles[SER_UART0].txfifo))
        {
-#ifdef CONFIG_SER_TXFILL
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 0)
                /*
                 * To avoid audio interference: always transmit useless char.
                 * Send the byte with the ninth bit cleared, the receiver in MCPM mode
@@ -241,38 +317,50 @@ SIGNAL(SIG_UART0_DATA)
                UDR0 = SER_FILL_BYTE;
 #else
                /* Disable UDR empty interrupt and transmitter */
-               UCR = BV(RXCIE) | BV(RXEN);
+               UCSR0B = BV(RXCIE) | BV(RXEN);
 #endif
        }
 #if defined(CONFIG_SER_HWHANDSHAKE)
        else if (IS_CTS_OFF)
        {
                // disable rx interrupt and tx, enable CTS interrupt
-               UCR = BV(RXCIE) | BV(RXEN);
+               UCSR0B = BV(RXCIE) | BV(RXEN);
                sbi(EIFR, EIMSKB_CTS);
                sbi(EIMSK, EIMSKB_CTS);
        }
 #endif // CONFIG_SER_HWHANDSHAKE
        else
        {
-#ifdef CONFIG_SER_TXFILL
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 0)
                /* Send with ninth bit set. Receiver in MCPM mode will receive it */
                UCSR0B |= BV(TXB8);
 #endif
-               UDR = fifo_pop(&ser_handles[SER_UART0].txfifo);
+               UDR0 = fifo_pop(&ser_handles[SER_UART0].txfifo);
        }
 }
 
+
+#ifdef AVR_HAS_UART1
+
 /*!
  * Serial 1 TX interrupt handler
  */
-#ifndef __AVR_ATmega103__
 SIGNAL(SIG_UART1_DATA)
 {
        if (fifo_isempty(&ser_handles[SER_UART1].txfifo))
        {
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 1)
+               /*
+                * To avoid audio interference: always transmit useless char.
+                * Send the byte with the ninth bit cleared, the receiver in MCPM mode
+                * will ignore it.
+                */
+               UCSR1B &= ~BV(TXB8);
+               UDR1 = SER_FILL_BYTE;
+#else
                /* Disable UDR empty interrupt and transmitter */
                UCSR1B = BV(RXCIE) | BV(RXEN);
+#endif
        }
 #if defined(CONFIG_SER_HWHANDSHAKE)
        else if (IS_CTS_OFF)
@@ -284,9 +372,15 @@ SIGNAL(SIG_UART1_DATA)
        }
 #endif // CONFIG_SER_HWHANDSHAKE
        else
+       {
+#if defined(CONFIG_SER_TXFILL) && (CONFIG_KBUS_SERIAL_PORT == 1)
+               /* Send with ninth bit set. Receiver in MCPM mode will receive it */
+               UCSR1B |= BV(TXB8);
+#endif
                UDR1 = fifo_pop(&ser_handles[SER_UART1].txfifo);
+       }
 }
-#endif /* !__AVR_ATmega103__ */
+#endif // AVR_HAS_UART1
 
 
 /*!
@@ -295,27 +389,23 @@ SIGNAL(SIG_UART1_DATA)
  * This handler is interruptible.
  * Interrupt are reenabled as soon as recv complete interrupt is
  * disabled. Using INTERRUPT() is troublesome when the serial
- * is heavily loaded, because and interrupt could be retriggered
+ * is heavily loaded, because an interrupt could be retriggered
  * when executing the handler prologue before RXCIE is disabled.
  */
-#ifdef __AVR_ATmega103__
-SIGNAL(SIG_UART_RECV)
-#else
 SIGNAL(SIG_UART0_RECV)
-#endif
 {
        /* Disable Recv complete IRQ */
-       UCR &= ~BV(RXCIE);
+       UCSR0B &= ~BV(RXCIE);
        ENABLE_INTS;
 
        /* Should be read before UDR */
-       ser_handles[SER_UART0].status |= USR & (SERRF_RXSROVERRUN | SERRF_FRAMEERROR);
+       ser_handles[SER_UART0].status |= UCSR0A & (SERRF_RXSROVERRUN | SERRF_FRAMEERROR);
 
        /* To clear the RXC flag we must _always_ read the UDR even when we're
         * not going to accept the incoming data, otherwise a new interrupt
         * will occur once the handler terminates.
         */
-       char c = UDR;
+       char c = UDR0;
 
        if (fifo_isfull(&ser_handles[SER_UART0].rxfifo))
                ser_handles[SER_UART0].status |= SERRF_RXFIFOOVERRUN;
@@ -328,23 +418,25 @@ SIGNAL(SIG_UART0_RECV)
 #endif
        }
        /* Reenable receive complete int */
-       UCR |= BV(RXCIE);
+       UCSR0B |= BV(RXCIE);
 }
 
+
+#ifdef AVR_HAS_UART1
+
 /*!
  * Serial 1 RX complete interrupt handler.
  *
  * This handler is interruptible.
  * Interrupt are reenabled as soon as recv complete interrupt is
  * disabled. Using INTERRUPT() is troublesome when the serial
- * is heavily loaded, because and interrupt could be retriggered
+ * is heavily loaded, because an interrupt could be retriggered
  * when executing the handler prologue before RXCIE is disabled.
  */
-#ifndef __AVR_ATmega103__
 SIGNAL(SIG_UART1_RECV)
 {
        /* Disable Recv complete IRQ */
-       UCSR0B &= ~BV(RXCIE);
+       UCSR1B &= ~BV(RXCIE);
        ENABLE_INTS;
 
        /* Should be read before UDR */
@@ -366,9 +458,10 @@ SIGNAL(SIG_UART1_RECV)
 #endif
        }
        /* Reenable receive complete int */
-       UCSR0B |= BV(RXCIE);
+       UCSR1B |= BV(RXCIE);
 }
-#endif /* !__AVR_ATmega103__ */
+
+#endif // AVR_HAS_UART1
 
 
 /*
@@ -377,12 +470,12 @@ SIGNAL(SIG_UART1_RECV)
  * This kludge is necessary because the SPI sends and receives bytes
  * at the same time and the SPI IRQ is unique for send/receive.
  * The only way to start transmission is to write data in SPDR (this
- * is done by ser_spi_starttx()). We do this *only* if a transfer is
+ * is done by spi_starttx()). We do this *only* if a transfer is
  * not already started.
  */
 static volatile bool spi_sending = false;
 
-static void spi_starttx(UNUSED(struct SerialHardware *ctx))
+static void spi_starttx(UNUSED(struct SerialHardware *ctx))
 {
        cpuflags_t flags;
 
@@ -420,18 +513,6 @@ SIGNAL(SIG_SPI)
 }
 
 
-/*
-
-#pragma vector = UART_TXC_vect
-__interrupt void UART_TXC_interrupt(void)
-{
-  UCSRB &= ~TXCIE;
-  ReceiveMode();
-  UCSRB = RXCIE | RXEN | TXEN;  //Abilito l'Interrupt in ricezione e RX e TX
-}
-*/
-
-
 static const struct SerialHardwareVT UART0_VT =
 {
        .init = uart0_init,
@@ -441,6 +522,7 @@ static const struct SerialHardwareVT UART0_VT =
        .enabletxirq = uart0_enabletxirq,
 };
 
+#ifdef AVR_HAS_UART1
 static const struct SerialHardwareVT UART1_VT =
 {
        .init = uart1_init,
@@ -449,27 +531,24 @@ static const struct SerialHardwareVT UART1_VT =
        .setparity = uart1_setparity,
        .enabletxirq = uart1_enabletxirq,
 };
+#endif // AVR_HAS_UART1
 
 static const struct SerialHardwareVT SPI_VT =
 {
        .init = spi_init,
        .cleanup = spi_cleanup,
+       .setbaudrate = spi_setbaudrate,
+       .setparity = spi_setparity,
        .enabletxirq = spi_starttx,
 };
 
 static struct AvrSerial UARTDescs[SER_CNT] =
 {
-       {
-               .hw = { .table = &UART0_VT },
-       },
-
-       {
-               .hw = { .table = &UART1_VT },
-       },
-
-       {
-               .hw = { .table = &SPI_VT },
-       },
+       { .hw = { .table = &UART0_VT } },
+#ifdef AVR_HAS_UART1
+       { .hw = { .table = &UART1_VT } },
+#endif // AVR_HAS_UART1
+       { .hw = { .table = &SPI_VT } },
 };
 
 struct SerialHardware* ser_hw_getdesc(int unit)