drivers/i2c/meson_i2c.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * (C) Copyright 2017 - Beniamino Galvani <b.galvani@gmail.com>
   4  */
   5 #include <common.h>
   6 #include <log.h>
   7 #include <asm/io.h>
   8 #include <clk.h>
   9 #include <dm.h>
  10 #include <i2c.h>
  11 #include <linux/delay.h>
  12 #include <linux/err.h>
  13
  14 #define I2C_TIMEOUT_MS          100
  15
  16 /* Control register fields */
  17 #define REG_CTRL_START          BIT(0)
  18 #define REG_CTRL_ACK_IGNORE     BIT(1)
  19 #define REG_CTRL_STATUS         BIT(2)
  20 #define REG_CTRL_ERROR          BIT(3)
  21 #define REG_CTRL_CLKDIV_SHIFT   12
  22 #define REG_CTRL_CLKDIV_MASK    GENMASK(21, 12)
  23 #define REG_CTRL_CLKDIVEXT_SHIFT 28
  24 #define REG_CTRL_CLKDIVEXT_MASK GENMASK(29, 28)
  25
  26 enum {
  27         TOKEN_END = 0,
  28         TOKEN_START,
  29         TOKEN_SLAVE_ADDR_WRITE,
  30         TOKEN_SLAVE_ADDR_READ,
  31         TOKEN_DATA,
  32         TOKEN_DATA_LAST,
  33         TOKEN_STOP,
  34 };
  35
  36 struct i2c_regs {
  37         u32 ctrl;
  38         u32 slave_addr;
  39         u32 tok_list0;
  40         u32 tok_list1;
  41         u32 tok_wdata0;
  42         u32 tok_wdata1;
  43         u32 tok_rdata0;
  44         u32 tok_rdata1;
  45 };
  46
  47 struct meson_i2c_data {
  48         unsigned char div_factor;
  49 };
  50
  51 struct meson_i2c {
  52         const struct meson_i2c_data *data;
  53         struct clk clk;
  54         struct i2c_regs *regs;
  55         struct i2c_msg *msg;    /* Current I2C message */
  56         bool last;              /* Whether the message is the last */
  57         uint count;             /* Number of bytes in the current transfer */
  58         uint pos;               /* Position of current transfer in message */
  59         u32 tokens[2];          /* Sequence of tokens to be written */
  60         uint num_tokens;        /* Number of tokens to be written */
  61 };
  62
  63 static void meson_i2c_reset_tokens(struct meson_i2c *i2c)
  64 {
  65         i2c->tokens[0] = 0;
  66         i2c->tokens[1] = 0;
  67         i2c->num_tokens = 0;
  68 }
  69
  70 static void meson_i2c_add_token(struct meson_i2c *i2c, int token)
  71 {
  72         if (i2c->num_tokens < 8)
  73                 i2c->tokens[0] |= (token & 0xf) << (i2c->num_tokens * 4);
  74         else
  75                 i2c->tokens[1] |= (token & 0xf) << ((i2c->num_tokens % 8) * 4);
  76
  77         i2c->num_tokens++;
  78 }
  79
  80 /*
  81  * Retrieve data for the current transfer (which can be at most 8
  82  * bytes) from the device internal buffer.
  83  */
  84 static void meson_i2c_get_data(struct meson_i2c *i2c, u8 *buf, int len)
  85 {
  86         u32 rdata0, rdata1;
  87         int i;
  88
  89         rdata0 = readl(&i2c->regs->tok_rdata0);
  90         rdata1 = readl(&i2c->regs->tok_rdata1);
  91
  92         debug("meson i2c: read data %08x %08x len %d\n", rdata0, rdata1, len);
  93
  94         for (i = 0; i < min(4, len); i++)
  95                 *buf++ = (rdata0 >> i * 8) & 0xff;
  96
  97         for (i = 4; i < min(8, len); i++)
  98                 *buf++ = (rdata1 >> (i - 4) * 8) & 0xff;
  99 }
 100
 101 /*
 102  * Write data for the current transfer (which can be at most 8 bytes)
 103  * to the device internal buffer.
 104  */
 105 static void meson_i2c_put_data(struct meson_i2c *i2c, u8 *buf, int len)
 106 {
 107         u32 wdata0 = 0, wdata1 = 0;
 108         int i;
 109
 110         for (i = 0; i < min(4, len); i++)
 111                 wdata0 |= *buf++ << (i * 8);
 112
 113         for (i = 4; i < min(8, len); i++)
 114                 wdata1 |= *buf++ << ((i - 4) * 8);
 115
 116         writel(wdata0, &i2c->regs->tok_wdata0);
 117         writel(wdata1, &i2c->regs->tok_wdata1);
 118
 119         debug("meson i2c: write data %08x %08x len %d\n", wdata0, wdata1, len);
 120 }
 121
 122 /*
 123  * Prepare the next transfer: pick the next 8 bytes in the remaining
 124  * part of message and write tokens and data (if needed) to the
 125  * device.
 126  */
 127 static void meson_i2c_prepare_xfer(struct meson_i2c *i2c)
 128 {
 129         bool write = !(i2c->msg->flags & I2C_M_RD);
 130         int i;
 131
 132         i2c->count = min(i2c->msg->len - i2c->pos, 8u);
 133
 134         for (i = 0; i + 1 < i2c->count; i++)
 135                 meson_i2c_add_token(i2c, TOKEN_DATA);
 136
 137         if (i2c->count) {
 138                 if (write || i2c->pos + i2c->count < i2c->msg->len)
 139                         meson_i2c_add_token(i2c, TOKEN_DATA);
 140                 else
 141                         meson_i2c_add_token(i2c, TOKEN_DATA_LAST);
 142         }
 143
 144         if (write)
 145                 meson_i2c_put_data(i2c, i2c->msg->buf + i2c->pos, i2c->count);
 146
 147         if (i2c->last && i2c->pos + i2c->count >= i2c->msg->len)
 148                 meson_i2c_add_token(i2c, TOKEN_STOP);
 149
 150         writel(i2c->tokens[0], &i2c->regs->tok_list0);
 151         writel(i2c->tokens[1], &i2c->regs->tok_list1);
 152 }
 153
 154 static void meson_i2c_do_start(struct meson_i2c *i2c, struct i2c_msg *msg)
 155 {
 156         int token;
 157
 158         token = (msg->flags & I2C_M_RD) ? TOKEN_SLAVE_ADDR_READ :
 159                 TOKEN_SLAVE_ADDR_WRITE;
 160
 161         writel(msg->addr << 1, &i2c->regs->slave_addr);
 162         meson_i2c_add_token(i2c, TOKEN_START);
 163         meson_i2c_add_token(i2c, token);
 164 }
 165
 166 static int meson_i2c_xfer_msg(struct meson_i2c *i2c, struct i2c_msg *msg,
 167                               int last)
 168 {
 169         ulong start;
 170
 171         debug("meson i2c: %s addr %u len %u\n",
 172               (msg->flags & I2C_M_RD) ? "read" : "write",
 173               msg->addr, msg->len);
 174
 175         i2c->msg = msg;
 176         i2c->last = last;
 177         i2c->pos = 0;
 178         i2c->count = 0;
 179
 180         meson_i2c_reset_tokens(i2c);
 181         meson_i2c_do_start(i2c, msg);
 182
 183         do {
 184                 meson_i2c_prepare_xfer(i2c);
 185
 186                 /* start the transfer */
 187                 setbits_le32(&i2c->regs->ctrl, REG_CTRL_START);
 188                 start = get_timer(0);
 189                 while (readl(&i2c->regs->ctrl) & REG_CTRL_STATUS) {
 190                         if (get_timer(start) > I2C_TIMEOUT_MS) {
 191                                 clrbits_le32(&i2c->regs->ctrl, REG_CTRL_START);
 192                                 debug("meson i2c: timeout\n");
 193                                 return -ETIMEDOUT;
 194                         }
 195                         udelay(1);
 196                 }
 197                 meson_i2c_reset_tokens(i2c);
 198                 clrbits_le32(&i2c->regs->ctrl, REG_CTRL_START);
 199
 200                 if (readl(&i2c->regs->ctrl) & REG_CTRL_ERROR) {
 201                         debug("meson i2c: error\n");
 202                         return -EREMOTEIO;
 203                 }
 204
 205                 if ((msg->flags & I2C_M_RD) && i2c->count) {
 206                         meson_i2c_get_data(i2c, i2c->msg->buf + i2c->pos,
 207                                            i2c->count);
 208                 }
 209                 i2c->pos += i2c->count;
 210         } while (i2c->pos < msg->len);
 211
 212         return 0;
 213 }
 214
 215 static int meson_i2c_xfer(struct udevice *bus, struct i2c_msg *msg,
 216                           int nmsgs)
 217 {
 218         struct meson_i2c *i2c = dev_get_priv(bus);
 219         int i, ret = 0;
 220
 221         for (i = 0; i < nmsgs; i++) {
 222                 ret = meson_i2c_xfer_msg(i2c, msg + i, i == nmsgs - 1);
 223                 if (ret)
 224                         return ret;
 225         }
 226
 227         return 0;
 228 }
 229
 230 static int meson_i2c_set_bus_speed(struct udevice *bus, unsigned int speed)
 231 {
 232         struct meson_i2c *i2c = dev_get_priv(bus);
 233         ulong clk_rate;
 234         unsigned int div;
 235
 236         clk_rate = clk_get_rate(&i2c->clk);
 237         if (IS_ERR_VALUE(clk_rate))
 238                 return -EINVAL;
 239
 240         div = DIV_ROUND_UP(clk_rate, speed * i2c->data->div_factor);
 241
 242         /* clock divider has 12 bits */
 243         if (div >= (1 << 12)) {
 244                 debug("meson i2c: requested bus frequency too low\n");
 245                 div = (1 << 12) - 1;
 246         }
 247
 248         clrsetbits_le32(&i2c->regs->ctrl, REG_CTRL_CLKDIV_MASK,
 249                         (div & GENMASK(9, 0)) << REG_CTRL_CLKDIV_SHIFT);
 250
 251         clrsetbits_le32(&i2c->regs->ctrl, REG_CTRL_CLKDIVEXT_MASK,
 252                         (div >> 10) << REG_CTRL_CLKDIVEXT_SHIFT);
 253
 254         debug("meson i2c: set clk %u, src %lu, div %u\n", speed, clk_rate, div);
 255
 256         return 0;
 257 }
 258
 259 static int meson_i2c_probe(struct udevice *bus)
 260 {
 261         struct meson_i2c *i2c = dev_get_priv(bus);
 262         int ret;
 263
 264         i2c->data = (const struct meson_i2c_data *)dev_get_driver_data(bus);
 265
 266         ret = clk_get_by_index(bus, 0, &i2c->clk);
 267         if (ret < 0)
 268                 return ret;
 269
 270         ret = clk_enable(&i2c->clk);
 271         if (ret)
 272                 return ret;
 273
 274         i2c->regs = dev_read_addr_ptr(bus);
 275         clrbits_le32(&i2c->regs->ctrl, REG_CTRL_START);
 276
 277         return 0;
 278 }
 279
 280 static const struct dm_i2c_ops meson_i2c_ops = {
 281         .xfer          = meson_i2c_xfer,
 282         .set_bus_speed = meson_i2c_set_bus_speed,
 283 };
 284
 285 static const struct meson_i2c_data i2c_meson6_data = {
 286         .div_factor = 4,
 287 };
 288
 289 static const struct meson_i2c_data i2c_gxbb_data = {
 290         .div_factor = 4,
 291 };
 292
 293 static const struct meson_i2c_data i2c_axg_data = {
 294         .div_factor = 3,
 295 };
 296
 297 static const struct udevice_id meson_i2c_ids[] = {
 298         {.compatible = "amlogic,meson6-i2c", .data = (ulong)&i2c_meson6_data},
 299         {.compatible = "amlogic,meson-gx-i2c", .data = (ulong)&i2c_gxbb_data},
 300         {.compatible = "amlogic,meson-gxbb-i2c", .data = (ulong)&i2c_gxbb_data},
 301         {.compatible = "amlogic,meson-axg-i2c", .data = (ulong)&i2c_axg_data},
 302         {}
 303 };
 304
 305 U_BOOT_DRIVER(i2c_meson) = {
 306         .name = "i2c_meson",
 307         .id   = UCLASS_I2C,
 308         .of_match = meson_i2c_ids,
 309         .probe = meson_i2c_probe,
 310         .priv_auto_alloc_size = sizeof(struct meson_i2c),
 311         .ops = &meson_i2c_ops,
 312 };