kernel/drivers/net/ethernet/altera/altera_sgdmahw.h

   1 /* Altera TSE SGDMA and MSGDMA Linux driver
   2  * Copyright (C) 2014 Altera Corporation. All rights reserved
   3  *
   4  * This program is free software; you can redistribute it and/or modify it
   5  * under the terms and conditions of the GNU General Public License,
   6  * version 2, as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope it will be useful, but WITHOUT
   9  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  10  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
  11  * more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along with
  14  * this program.  If not, see <http://www.gnu.org/licenses/>.
  15  */
  16
  17 #ifndef __ALTERA_SGDMAHW_H__
  18 #define __ALTERA_SGDMAHW_H__
  19
  20 /* SGDMA descriptor structure */
  21 struct sgdma_descrip {
  22         u32     raddr; /* address of data to be read */
  23         u32     pad1;
  24         u32     waddr;
  25         u32     pad2;
  26         u32     next;
  27         u32     pad3;
  28         u16     bytes;
  29         u8      rburst;
  30         u8      wburst;
  31         u16     bytes_xferred;  /* 16 bits, bytes xferred */
  32
  33         /* bit 0: error
  34          * bit 1: length error
  35          * bit 2: crc error
  36          * bit 3: truncated error
  37          * bit 4: phy error
  38          * bit 5: collision error
  39          * bit 6: reserved
  40          * bit 7: status eop for recv case
  41          */
  42         u8      status;
  43
  44         /* bit 0: eop
  45          * bit 1: read_fixed
  46          * bit 2: write fixed
  47          * bits 3,4,5,6: Channel (always 0)
  48          * bit 7: hardware owned
  49          */
  50         u8      control;
  51 } __packed;
  52
  53
  54 #define SGDMA_STATUS_ERR                BIT(0)
  55 #define SGDMA_STATUS_LENGTH_ERR         BIT(1)
  56 #define SGDMA_STATUS_CRC_ERR            BIT(2)
  57 #define SGDMA_STATUS_TRUNC_ERR          BIT(3)
  58 #define SGDMA_STATUS_PHY_ERR            BIT(4)
  59 #define SGDMA_STATUS_COLL_ERR           BIT(5)
  60 #define SGDMA_STATUS_EOP                BIT(7)
  61
  62 #define SGDMA_CONTROL_EOP               BIT(0)
  63 #define SGDMA_CONTROL_RD_FIXED          BIT(1)
  64 #define SGDMA_CONTROL_WR_FIXED          BIT(2)
  65
  66 /* Channel is always 0, so just zero initialize it */
  67
  68 #define SGDMA_CONTROL_HW_OWNED          BIT(7)
  69
  70 /* SGDMA register space */
  71 struct sgdma_csr {
  72         /* bit 0: error
  73          * bit 1: eop
  74          * bit 2: descriptor completed
  75          * bit 3: chain completed
  76          * bit 4: busy
  77          * remainder reserved
  78          */
  79         u32     status;
  80         u32     pad1[3];
  81
  82         /* bit 0: interrupt on error
  83          * bit 1: interrupt on eop
  84          * bit 2: interrupt after every descriptor
  85          * bit 3: interrupt after last descrip in a chain
  86          * bit 4: global interrupt enable
  87          * bit 5: starts descriptor processing
  88          * bit 6: stop core on dma error
  89          * bit 7: interrupt on max descriptors
  90          * bits 8-15: max descriptors to generate interrupt
  91          * bit 16: Software reset
  92          * bit 17: clears owned by hardware if 0, does not clear otherwise
  93          * bit 18: enables descriptor polling mode
  94          * bit 19-26: clocks before polling again
  95          * bit 27-30: reserved
  96          * bit 31: clear interrupt
  97          */
  98         u32     control;
  99         u32     pad2[3];
 100         u32     next_descrip;
 101         u32     pad3[3];
 102 };
 103
 104 #define sgdma_csroffs(a) (offsetof(struct sgdma_csr, a))
 105 #define sgdma_descroffs(a) (offsetof(struct sgdma_descrip, a))
 106
 107 #define SGDMA_STSREG_ERR        BIT(0) /* Error */
 108 #define SGDMA_STSREG_EOP        BIT(1) /* EOP */
 109 #define SGDMA_STSREG_DESCRIP    BIT(2) /* Descriptor completed */
 110 #define SGDMA_STSREG_CHAIN      BIT(3) /* Chain completed */
 111 #define SGDMA_STSREG_BUSY       BIT(4) /* Controller busy */
 112
 113 #define SGDMA_CTRLREG_IOE       BIT(0) /* Interrupt on error */
 114 #define SGDMA_CTRLREG_IOEOP     BIT(1) /* Interrupt on EOP */
 115 #define SGDMA_CTRLREG_IDESCRIP  BIT(2) /* Interrupt after every descriptor */
 116 #define SGDMA_CTRLREG_ILASTD    BIT(3) /* Interrupt after last descriptor */
 117 #define SGDMA_CTRLREG_INTEN     BIT(4) /* Global Interrupt enable */
 118 #define SGDMA_CTRLREG_START     BIT(5) /* starts descriptor processing */
 119 #define SGDMA_CTRLREG_STOPERR   BIT(6) /* stop on dma error */
 120 #define SGDMA_CTRLREG_INTMAX    BIT(7) /* Interrupt on max descriptors */
 121 #define SGDMA_CTRLREG_RESET     BIT(16)/* Software reset */
 122 #define SGDMA_CTRLREG_COBHW     BIT(17)/* Clears owned by hardware */
 123 #define SGDMA_CTRLREG_POLL      BIT(18)/* enables descriptor polling mode */
 124 #define SGDMA_CTRLREG_CLRINT    BIT(31)/* Clears interrupt */
 125
 126 #endif /* __ALTERA_SGDMAHW_H__ */