include/nios2-yanu.h

   1 /*
   2  * (C) Copyright 2006, Imagos S.a.s <www.imagos.it>
   3  * Renato Andreola <renato.andreola@imagos.it>
   4  *
   5  * See file CREDITS for list of people who contributed to this
   6  * project.
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License as
  10  * published by the Free Software Foundation; either version 2 of
  11  * the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software
  20  * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
  21  * MA 02111-1307 USA
  22  */
  23
  24 /*************************************************************************
  25  * Altera NiosII YANU serial interface by Imagos
  26  * please see  http://www.opencores.org/project,yanu for
  27  * information/downloads
  28  ************************************************************************/
  29
  30 #ifndef __NIOS2_YANU_H__
  31 #define __NIOS2_YANU_H__
  32
  33 #define YANU_MAX_PRESCALER_N   ((1 << 4) - 1)   /* 15 */
  34 #define YANU_MAX_PRESCALER_M   ((1 << 11) -1)   /* 2047 */
  35 #define YANU_FIFO_SIZE         (16)
  36 #define YANU_RXFIFO_SIZE       (YANU_FIFO_SIZE)
  37 #define YANU_TXFIFO_SIZE       (YANU_FIFO_SIZE)
  38
  39 #define YANU_RXFIFO_DLY        (10*11)
  40 #define YANU_TXFIFO_THR        (10)
  41 #define YANU_DATA_CHAR_MASK    (0xFF)
  42
  43 /* data register */
  44 #define YANU_DATA_OFFSET       (0)      /* data register offset */
  45
  46 #define YANU_CONTROL_OFFSET    (4)      /* control register offset */
  47 /* interrupt enable */
  48 #define YANU_CONTROL_IE_RRDY   (1<<0)   /* ie on received character ready */
  49 #define YANU_CONTROL_IE_OE     (1<<1)   /* ie on rx overrun    */
  50 #define YANU_CONTROL_IE_BRK    (1<<2)   /* ie on break detect  */
  51 #define YANU_CONTROL_IE_FE     (1<<3)   /* ie on framing error */
  52 #define YANU_CONTROL_IE_PE     (1<<4)   /* ie on parity error  */
  53 #define YANU_CONTROL_IE_TRDY   (1<<5)   /* ie interrupt on tranmitter ready */
  54 /* control bits */
  55 #define YANU_CONTROL_BITS_POS  (6)      /* bits number pos */
  56 #define YANU_CONTROL_BITS      (1<<YANU_CONTROL_BITS_POS)       /* number of rx/tx bits per word. 3 bit unsigned integer */
  57 #define YANU_CONTROL_BITS_N    (3)      /* ... its bit filed length */
  58 #define YANU_CONTROL_PARENA    (1<<9)   /*  enable parity bit transmission/reception */
  59 #define YANU_CONTROL_PAREVEN   (1<<10)  /* parity even */
  60 #define YANU_CONTROL_STOPS     (1<<11)  /* number of stop bits */
  61 #define YANU_CONTROL_HHENA     (1<<12)  /* Harware Handshake enable... */
  62 #define YANU_CONTROL_FORCEBRK  (1<<13)  /* if set than txd = active (0) */
  63 /* tuning part */
  64 #define YANU_CONTROL_RDYDLY    (1<<14)  /* delay from "first" before setting rrdy (in bit) */
  65 #define YANU_CONTROL_RDYDLY_N  (8)      /* ... its bit filed length */
  66 #define YANU_CONTROL_TXTHR     (1<<22)  /* tx interrupt threshold: the trdy set if txfifo_chars<= txthr (chars) */
  67 #define YANU_CONTROL_TXTHR_N   (4)      /* ... its bit field length */
  68
  69 #define YANU_BAUD_OFFSET  (8)   /* baud register offset */
  70 #define YANU_BAUDM        (1<<0)        /* baud mantissa lsb */
  71 #define YANU_BAUDM_N      (12)  /* ...its bit filed length */
  72 #define YANU_BAUDE        (1<<12)       /* baud exponent lsb */
  73 #define YANU_BAUDE_N      (4)   /* ...its bit field length */
  74
  75 #define YANU_ACTION_OFFSET   (12)       /* action register... write only */
  76 #define YANU_ACTION_RRRDY    (1<<0)     /* reset rrdy */
  77 #define YANU_ACTION_ROE      (1<<1)     /* reset oe */
  78 #define YANU_ACTION_RBRK     (1<<2)     /* reset brk */
  79 #define YANU_ACTION_RFE      (1<<3)     /* reset fe  */
  80 #define YANU_ACTION_RPE      (1<<4)     /* reset pe  */
  81 #define YANU_ACTION_SRRDY    (1<<5)     /* set rrdy  */
  82 #define YANU_ACTION_SOE      (1<<6)     /* set oe    */
  83 #define YANU_ACTION_SBRK     (1<<7)     /* set brk   */
  84 #define YANU_ACTION_SFE      (1<<8)     /* set fe    */
  85 #define YANU_ACTION_SPE      (1<<9)     /* set pe    */
  86 #define YANU_ACTION_RFIFO_PULL  (1<<10) /* pull a char from rx fifo we MUST do it before taking a char */
  87 #define YANU_ACTION_RFIFO_CLEAR (1<<11) /* clear rx fifo */
  88 #define YANU_ACTION_TFIFO_CLEAR (1<<12) /* clear tx fifo */
  89 #define YANU_ACTION_RTRDY       (1<<13) /* clear trdy    */
  90 #define YANU_ACTION_STRDY       (1<<14) /* set trdy      */
  91
  92 #define YANU_STATUS_OFFSET   (16)
  93 #define YANU_STATUS_RRDY     (1<<0)     /* rxrdy flag */
  94 #define YANU_STATUS_TRDY     (1<<1)     /* txrdy flag */
  95 #define YANU_STATUS_OE       (1<<2)     /* rx overrun error */
  96 #define YANU_STATUS_BRK      (1<<3)     /* rx break detect flag */
  97 #define YANU_STATUS_FE       (1<<4)     /* rx framing error flag */
  98 #define YANU_STATUS_PE       (1<<5)     /* rx parity erro flag */
  99 #define YANU_RFIFO_CHARS_POS (6)
 100 #define YANU_RFIFO_CHARS     (1<<RFIFO_CHAR_POS)        /* number of chars into rx fifo */
 101 #define YANU_RFIFO_CHARS_N   (5)        /* ...its bit field length: 32 chars */
 102 #define YANU_TFIFO_CHARS_POS (11)
 103 #define YANU_TFIFO_CHARS     (1<<TFIFO_CHAR_POS)        /* number of chars into tx fifo */
 104 #define YANU_TFIFO_CHARS_N   (5)        /* ...its bit field length: 32 chars */
 105
 106 typedef volatile struct yanu_uart_t {
 107         volatile unsigned data;
 108         volatile unsigned control;      /* control register (RW) 32-bit   */
 109         volatile unsigned baud; /* baud/prescaler register (RW) 32-bit */
 110         volatile unsigned action;       /* action register (W) 32-bit */
 111         volatile unsigned status;       /* status register (R) 32-bit */
 112         volatile unsigned magic;        /* magic register (R) 32-bit */
 113 } yanu_uart_t;
 114
 115 #endif