drivers/i2c/busses/i2c-iop3xx.h

   1 /* ------------------------------------------------------------------------- */
   2 /* i2c-iop3xx.h algorithm driver definitions private to i2c-iop3xx.c         */
   3 /* ------------------------------------------------------------------------- */
   4 /*   Copyright (C) 2003 Peter Milne, D-TACQ Solutions Ltd
   5  *                      <Peter dot Milne at D hyphen TACQ dot com>
   6
   7     This program is free software; you can redistribute it and/or modify
   8     it under the terms of the GNU General Public License as published by
   9     the Free Software Foundation, version 2.
  10
  11     This program is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with this program; if not, write to the Free Software
  18     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                */
  19 /* ------------------------------------------------------------------------- */
  20
  21
  22 #ifndef I2C_IOP3XX_H
  23 #define I2C_IOP3XX_H 1
  24
  25 /*
  26  * iop321 hardware bit definitions
  27  */
  28 #define IOP321_ICR_FAST_MODE    0x8000  /* 1=400kBps, 0=100kBps */
  29 #define IOP321_ICR_UNIT_RESET   0x4000  /* 1=RESET */
  30 #define IOP321_ICR_SADIE        0x2000  /* 1=Slave Detect Interrupt Enable */
  31 #define IOP321_ICR_ALDIE        0x1000  /* 1=Arb Loss Detect Interrupt Enable */
  32 #define IOP321_ICR_SSDIE        0x0800  /* 1=Slave STOP Detect Interrupt Enable */
  33 #define IOP321_ICR_BERRIE       0x0400  /* 1=Bus Error Interrupt Enable */
  34 #define IOP321_ICR_RXFULLIE     0x0200  /* 1=Receive Full Interrupt Enable */
  35 #define IOP321_ICR_TXEMPTYIE    0x0100  /* 1=Transmit Empty Interrupt Enable */
  36 #define IOP321_ICR_GCD          0x0080  /* 1=General Call Disable */
  37 /*
  38  * IOP321_ICR_GCD: 1 disables response as slave. "This bit must be set
  39  * when sending a master mode general call message from the I2C unit"
  40  */
  41 #define IOP321_ICR_UE           0x0040  /* 1=Unit Enable */
  42 /*
  43  * "NOTE: To avoid I2C bus integrity problems,
  44  * the user needs to ensure that the GPIO Output Data Register -
  45  * GPOD bits associated with an I2C port are cleared prior to setting
  46  * the enable bit for that I2C serial port.
  47  * The user prepares to enable I2C port 0 and
  48  * I2C port 1 by clearing GPOD bits 7:6 and GPOD bits 5:4, respectively.
  49  */
  50 #define IOP321_ICR_SCLEN        0x0020  /* 1=SCL enable for master mode */
  51 #define IOP321_ICR_MABORT       0x0010  /* 1=Send a STOP with no data
  52                                          * NB TBYTE must be clear */
  53 #define IOP321_ICR_TBYTE        0x0008  /* 1=Send/Receive a byte. i2c clears */
  54 #define IOP321_ICR_NACK         0x0004  /* 1=reply with NACK */
  55 #define IOP321_ICR_MSTOP        0x0002  /* 1=send a STOP after next data byte */
  56 #define IOP321_ICR_MSTART       0x0001  /* 1=initiate a START */
  57
  58
  59 #define IOP321_ISR_BERRD        0x0400  /* 1=BUS ERROR Detected */
  60 #define IOP321_ISR_SAD          0x0200  /* 1=Slave ADdress Detected */
  61 #define IOP321_ISR_GCAD         0x0100  /* 1=General Call Address Detected */
  62 #define IOP321_ISR_RXFULL       0x0080  /* 1=Receive Full */
  63 #define IOP321_ISR_TXEMPTY      0x0040  /* 1=Transmit Empty */
  64 #define IOP321_ISR_ALD          0x0020  /* 1=Arbitration Loss Detected */
  65 #define IOP321_ISR_SSD          0x0010  /* 1=Slave STOP Detected */
  66 #define IOP321_ISR_BBUSY        0x0008  /* 1=Bus BUSY */
  67 #define IOP321_ISR_UNITBUSY     0x0004  /* 1=Unit Busy */
  68 #define IOP321_ISR_NACK         0x0002  /* 1=Unit Rx or Tx a NACK */
  69 #define IOP321_ISR_RXREAD       0x0001  /* 1=READ 0=WRITE (R/W bit of slave addr */
  70
  71 #define IOP321_ISR_CLEARBITS    0x07f0
  72
  73 #define IOP321_ISAR_SAMASK      0x007f
  74
  75 #define IOP321_IDBR_MASK        0x00ff
  76
  77 #define IOP321_IBMR_SCL         0x0002
  78 #define IOP321_IBMR_SDA         0x0001
  79
  80 #define IOP321_GPOD_I2C0        0x00c0  /* clear these bits to enable ch0 */
  81 #define IOP321_GPOD_I2C1        0x0030  /* clear these bits to enable ch1 */
  82
  83 #define MYSAR                   0x02    /* SWAG a suitable slave address */
  84
  85 #define I2C_ERR                 321
  86 #define I2C_ERR_BERR            (I2C_ERR+0)
  87 #define I2C_ERR_ALD             (I2C_ERR+1)
  88
  89
  90 struct iop3xx_biu {                /* Bus Interface Unit - the hardware */
  91 /* physical hardware defs - regs*/
  92         u32 *CR;
  93         u32 *SR;
  94         u32 *SAR;
  95         u32 *DBR;
  96         u32 *BMR;
  97 /* irq bit vector */
  98         u32 irq;
  99 /* stored flags */
 100         u32 SR_enabled, SR_received;
 101 };
 102
 103 struct i2c_algo_iop3xx_data {
 104         int channel;
 105
 106         wait_queue_head_t waitq;
 107         spinlock_t lock;
 108         int timeout;
 109         struct iop3xx_biu* biu;
 110 };
 111
 112 #define REGION_START(adap)      ((u32)((adap)->biu->CR))
 113 #define REGION_END(adap)        ((u32)((adap)->biu->BMR+1))
 114 #define REGION_LENGTH(adap)     (REGION_END(adap)-REGION_START(adap))
 115
 116 #define IRQ_STATUS_MASK(adap)   (1<<adap->biu->irq)
 117
 118 #endif /* I2C_IOP3XX_H */