include/asm-mips/dma.h

   1 /*
   2  * linux/include/asm/dma.h: Defines for using and allocating dma channels.
   3  * Written by Hennus Bergman, 1992.
   4  * High DMA channel support & info by Hannu Savolainen
   5  * and John Boyd, Nov. 1992.
   6  *
   7  * NOTE: all this is true *only* for ISA/EISA expansions on Mips boards
   8  * and can only be used for expansion cards. Onboard DMA controllers, such
   9  * as the R4030 on Jazz boards behave totally different!
  10  */
  11
  12 #ifndef _ASM_DMA_H
  13 #define _ASM_DMA_H
  14
  15 #include <asm/io.h>                     /* need byte IO */
  16 #include <linux/spinlock.h>             /* And spinlocks */
  17 #include <linux/delay.h>
  18 #include <asm/system.h>
  19
  20
  21 #ifdef HAVE_REALLY_SLOW_DMA_CONTROLLER
  22 #define dma_outb        outb_p
  23 #else
  24 #define dma_outb        outb
  25 #endif
  26
  27 #define dma_inb         inb
  28
  29 /*
  30  * NOTES about DMA transfers:
  31  *
  32  *  controller 1: channels 0-3, byte operations, ports 00-1F
  33  *  controller 2: channels 4-7, word operations, ports C0-DF
  34  *
  35  *  - ALL registers are 8 bits only, regardless of transfer size
  36  *  - channel 4 is not used - cascades 1 into 2.
  37  *  - channels 0-3 are byte - addresses/counts are for physical bytes
  38  *  - channels 5-7 are word - addresses/counts are for physical words
  39  *  - transfers must not cross physical 64K (0-3) or 128K (5-7) boundaries
  40  *  - transfer count loaded to registers is 1 less than actual count
  41  *  - controller 2 offsets are all even (2x offsets for controller 1)
  42  *  - page registers for 5-7 don't use data bit 0, represent 128K pages
  43  *  - page registers for 0-3 use bit 0, represent 64K pages
  44  *
  45  * DMA transfers are limited to the lower 16MB of _physical_ memory.
  46  * Note that addresses loaded into registers must be _physical_ addresses,
  47  * not logical addresses (which may differ if paging is active).
  48  *
  49  *  Address mapping for channels 0-3:
  50  *
  51  *   A23 ... A16 A15 ... A8  A7 ... A0    (Physical addresses)
  52  *    |  ...  |   |  ... |   |  ... |
  53  *    |  ...  |   |  ... |   |  ... |
  54  *    |  ...  |   |  ... |   |  ... |
  55  *   P7  ...  P0  A7 ... A0  A7 ... A0
  56  * |    Page    | Addr MSB | Addr LSB |   (DMA registers)
  57  *
  58  *  Address mapping for channels 5-7:
  59  *
  60  *   A23 ... A17 A16 A15 ... A9 A8 A7 ... A1 A0    (Physical addresses)
  61  *    |  ...  |   \   \   ... \  \  \  ... \  \
  62  *    |  ...  |    \   \   ... \  \  \  ... \  (not used)
  63  *    |  ...  |     \   \   ... \  \  \  ... \
  64  *   P7  ...  P1 (0) A7 A6  ... A0 A7 A6 ... A0
  65  * |      Page      |  Addr MSB   |  Addr LSB  |   (DMA registers)
  66  *
  67  * Again, channels 5-7 transfer _physical_ words (16 bits), so addresses
  68  * and counts _must_ be word-aligned (the lowest address bit is _ignored_ at
  69  * the hardware level, so odd-byte transfers aren't possible).
  70  *
  71  * Transfer count (_not # bytes_) is limited to 64K, represented as actual
  72  * count - 1 : 64K => 0xFFFF, 1 => 0x0000.  Thus, count is always 1 or more,
  73  * and up to 128K bytes may be transferred on channels 5-7 in one operation.
  74  *
  75  */
  76
  77 #ifndef CONFIG_GENERIC_ISA_DMA_SUPPORT_BROKEN
  78 #define MAX_DMA_CHANNELS        8
  79 #endif
  80
  81 /*
  82  * The maximum address in KSEG0 that we can perform a DMA transfer to on this
  83  * platform.  This describes only the PC style part of the DMA logic like on
  84  * Deskstations or Acer PICA but not the much more versatile DMA logic used
  85  * for the local devices on Acer PICA or Magnums.
  86  */
  87 #ifdef CONFIG_SGI_IP22
  88 /* Horrible hack to have a correct DMA window on IP22 */
  89 #include <asm/sgi/mc.h>
  90 #define MAX_DMA_ADDRESS         (PAGE_OFFSET + SGIMC_SEG0_BADDR + 0x01000000)
  91 #else
  92 #define MAX_DMA_ADDRESS         (PAGE_OFFSET + 0x01000000)
  93 #endif
  94 #define MAX_DMA_PFN             PFN_DOWN(virt_to_phys((void *)MAX_DMA_ADDRESS))
  95 #define MAX_DMA32_PFN           (1UL << (32 - PAGE_SHIFT))
  96
  97 /* 8237 DMA controllers */
  98 #define IO_DMA1_BASE    0x00    /* 8 bit slave DMA, channels 0..3 */
  99 #define IO_DMA2_BASE    0xC0    /* 16 bit master DMA, ch 4(=slave input)..7 */
 100
 101 /* DMA controller registers */
 102 #define DMA1_CMD_REG            0x08    /* command register (w) */
 103 #define DMA1_STAT_REG           0x08    /* status register (r) */
 104 #define DMA1_REQ_REG            0x09    /* request register (w) */
 105 #define DMA1_MASK_REG           0x0A    /* single-channel mask (w) */
 106 #define DMA1_MODE_REG           0x0B    /* mode register (w) */
 107 #define DMA1_CLEAR_FF_REG       0x0C    /* clear pointer flip-flop (w) */
 108 #define DMA1_TEMP_REG           0x0D    /* Temporary Register (r) */
 109 #define DMA1_RESET_REG          0x0D    /* Master Clear (w) */
 110 #define DMA1_CLR_MASK_REG       0x0E    /* Clear Mask */
 111 #define DMA1_MASK_ALL_REG       0x0F    /* all-channels mask (w) */
 112
 113 #define DMA2_CMD_REG            0xD0    /* command register (w) */
 114 #define DMA2_STAT_REG           0xD0    /* status register (r) */
 115 #define DMA2_REQ_REG            0xD2    /* request register (w) */
 116 #define DMA2_MASK_REG           0xD4    /* single-channel mask (w) */
 117 #define DMA2_MODE_REG           0xD6    /* mode register (w) */
 118 #define DMA2_CLEAR_FF_REG       0xD8    /* clear pointer flip-flop (w) */
 119 #define DMA2_TEMP_REG           0xDA    /* Temporary Register (r) */
 120 #define DMA2_RESET_REG          0xDA    /* Master Clear (w) */
 121 #define DMA2_CLR_MASK_REG       0xDC    /* Clear Mask */
 122 #define DMA2_MASK_ALL_REG       0xDE    /* all-channels mask (w) */
 123
 124 #define DMA_ADDR_0              0x00    /* DMA address registers */
 125 #define DMA_ADDR_1              0x02
 126 #define DMA_ADDR_2              0x04
 127 #define DMA_ADDR_3              0x06
 128 #define DMA_ADDR_4              0xC0
 129 #define DMA_ADDR_5              0xC4
 130 #define DMA_ADDR_6              0xC8
 131 #define DMA_ADDR_7              0xCC
 132
 133 #define DMA_CNT_0               0x01    /* DMA count registers */
 134 #define DMA_CNT_1               0x03
 135 #define DMA_CNT_2               0x05
 136 #define DMA_CNT_3               0x07
 137 #define DMA_CNT_4               0xC2
 138 #define DMA_CNT_5               0xC6
 139 #define DMA_CNT_6               0xCA
 140 #define DMA_CNT_7               0xCE
 141
 142 #define DMA_PAGE_0              0x87    /* DMA page registers */
 143 #define DMA_PAGE_1              0x83
 144 #define DMA_PAGE_2              0x81
 145 #define DMA_PAGE_3              0x82
 146 #define DMA_PAGE_5              0x8B
 147 #define DMA_PAGE_6              0x89
 148 #define DMA_PAGE_7              0x8A
 149
 150 #define DMA_MODE_READ   0x44    /* I/O to memory, no autoinit, increment, single mode */
 151 #define DMA_MODE_WRITE  0x48    /* memory to I/O, no autoinit, increment, single mode */
 152 #define DMA_MODE_CASCADE 0xC0   /* pass thru DREQ->HRQ, DACK<-HLDA only */
 153
 154 #define DMA_AUTOINIT    0x10
 155
 156 extern spinlock_t  dma_spin_lock;
 157
 158 static __inline__ unsigned long claim_dma_lock(void)
 159 {
 160         unsigned long flags;
 161         spin_lock_irqsave(&dma_spin_lock, flags);
 162         return flags;
 163 }
 164
 165 static __inline__ void release_dma_lock(unsigned long flags)
 166 {
 167         spin_unlock_irqrestore(&dma_spin_lock, flags);
 168 }
 169
 170 /* enable/disable a specific DMA channel */
 171 static __inline__ void enable_dma(unsigned int dmanr)
 172 {
 173         if (dmanr<=3)
 174                 dma_outb(dmanr,  DMA1_MASK_REG);
 175         else
 176                 dma_outb(dmanr & 3,  DMA2_MASK_REG);
 177 }
 178
 179 static __inline__ void disable_dma(unsigned int dmanr)
 180 {
 181         if (dmanr<=3)
 182                 dma_outb(dmanr | 4,  DMA1_MASK_REG);
 183         else
 184                 dma_outb((dmanr & 3) | 4,  DMA2_MASK_REG);
 185 }
 186
 187 /* Clear the 'DMA Pointer Flip Flop'.
 188  * Write 0 for LSB/MSB, 1 for MSB/LSB access.
 189  * Use this once to initialize the FF to a known state.
 190  * After that, keep track of it. :-)
 191  * --- In order to do that, the DMA routines below should ---
 192  * --- only be used while holding the DMA lock ! ---
 193  */
 194 static __inline__ void clear_dma_ff(unsigned int dmanr)
 195 {
 196         if (dmanr<=3)
 197                 dma_outb(0,  DMA1_CLEAR_FF_REG);
 198         else
 199                 dma_outb(0,  DMA2_CLEAR_FF_REG);
 200 }
 201
 202 /* set mode (above) for a specific DMA channel */
 203 static __inline__ void set_dma_mode(unsigned int dmanr, char mode)
 204 {
 205         if (dmanr<=3)
 206                 dma_outb(mode | dmanr,  DMA1_MODE_REG);
 207         else
 208                 dma_outb(mode | (dmanr&3),  DMA2_MODE_REG);
 209 }
 210
 211 /* Set only the page register bits of the transfer address.
 212  * This is used for successive transfers when we know the contents of
 213  * the lower 16 bits of the DMA current address register, but a 64k boundary
 214  * may have been crossed.
 215  */
 216 static __inline__ void set_dma_page(unsigned int dmanr, char pagenr)
 217 {
 218         switch(dmanr) {
 219                 case 0:
 220                         dma_outb(pagenr, DMA_PAGE_0);
 221                         break;
 222                 case 1:
 223                         dma_outb(pagenr, DMA_PAGE_1);
 224                         break;
 225                 case 2:
 226                         dma_outb(pagenr, DMA_PAGE_2);
 227                         break;
 228                 case 3:
 229                         dma_outb(pagenr, DMA_PAGE_3);
 230                         break;
 231                 case 5:
 232                         dma_outb(pagenr & 0xfe, DMA_PAGE_5);
 233                         break;
 234                 case 6:
 235                         dma_outb(pagenr & 0xfe, DMA_PAGE_6);
 236                         break;
 237                 case 7:
 238                         dma_outb(pagenr & 0xfe, DMA_PAGE_7);
 239                         break;
 240         }
 241 }
 242
 243
 244 /* Set transfer address & page bits for specific DMA channel.
 245  * Assumes dma flipflop is clear.
 246  */
 247 static __inline__ void set_dma_addr(unsigned int dmanr, unsigned int a)
 248 {
 249         set_dma_page(dmanr, a>>16);
 250         if (dmanr <= 3)  {
 251             dma_outb( a & 0xff, ((dmanr&3)<<1) + IO_DMA1_BASE );
 252             dma_outb( (a>>8) & 0xff, ((dmanr&3)<<1) + IO_DMA1_BASE );
 253         }  else  {
 254             dma_outb( (a>>1) & 0xff, ((dmanr&3)<<2) + IO_DMA2_BASE );
 255             dma_outb( (a>>9) & 0xff, ((dmanr&3)<<2) + IO_DMA2_BASE );
 256         }
 257 }
 258
 259
 260 /* Set transfer size (max 64k for DMA0..3, 128k for DMA5..7) for
 261  * a specific DMA channel.
 262  * You must ensure the parameters are valid.
 263  * NOTE: from a manual: "the number of transfers is one more
 264  * than the initial word count"! This is taken into account.
 265  * Assumes dma flip-flop is clear.
 266  * NOTE 2: "count" represents _bytes_ and must be even for channels 5-7.
 267  */
 268 static __inline__ void set_dma_count(unsigned int dmanr, unsigned int count)
 269 {
 270         count--;
 271         if (dmanr <= 3)  {
 272             dma_outb( count & 0xff, ((dmanr&3)<<1) + 1 + IO_DMA1_BASE );
 273             dma_outb( (count>>8) & 0xff, ((dmanr&3)<<1) + 1 + IO_DMA1_BASE );
 274         } else {
 275             dma_outb( (count>>1) & 0xff, ((dmanr&3)<<2) + 2 + IO_DMA2_BASE );
 276             dma_outb( (count>>9) & 0xff, ((dmanr&3)<<2) + 2 + IO_DMA2_BASE );
 277         }
 278 }
 279
 280
 281 /* Get DMA residue count. After a DMA transfer, this
 282  * should return zero. Reading this while a DMA transfer is
 283  * still in progress will return unpredictable results.
 284  * If called before the channel has been used, it may return 1.
 285  * Otherwise, it returns the number of _bytes_ left to transfer.
 286  *
 287  * Assumes DMA flip-flop is clear.
 288  */
 289 static __inline__ int get_dma_residue(unsigned int dmanr)
 290 {
 291         unsigned int io_port = (dmanr<=3)? ((dmanr&3)<<1) + 1 + IO_DMA1_BASE
 292                                          : ((dmanr&3)<<2) + 2 + IO_DMA2_BASE;
 293
 294         /* using short to get 16-bit wrap around */
 295         unsigned short count;
 296
 297         count = 1 + dma_inb(io_port);
 298         count += dma_inb(io_port) << 8;
 299
 300         return (dmanr<=3)? count : (count<<1);
 301 }
 302
 303
 304 /* These are in kernel/dma.c: */
 305 extern int request_dma(unsigned int dmanr, const char * device_id);     /* reserve a DMA channel */
 306 extern void free_dma(unsigned int dmanr);       /* release it again */
 307
 308 /* From PCI */
 309
 310 #ifdef CONFIG_PCI
 311 extern int isa_dma_bridge_buggy;
 312 #else
 313 #define isa_dma_bridge_buggy    (0)
 314 #endif
 315
 316 #endif /* _ASM_DMA_H */