1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2 /* Copyright (c) 2016-2018 Mellanox Technologies. All rights reserved */
6 #include <linux/init.h>
7 #include <linux/jiffies.h>
8 #include <linux/kernel.h>
9 #include <linux/mutex.h>
10 #include <linux/module.h>
11 #include <linux/mod_devicetable.h>
12 #include <linux/slab.h>
17 #include "resources.h"
19 #define MLXSW_I2C_CIR2_BASE 0x72000
20 #define MLXSW_I2C_CIR_STATUS_OFF 0x18
21 #define MLXSW_I2C_CIR2_OFF_STATUS (MLXSW_I2C_CIR2_BASE + \
22 MLXSW_I2C_CIR_STATUS_OFF)
23 #define MLXSW_I2C_OPMOD_SHIFT 12
24 #define MLXSW_I2C_EVENT_BIT_SHIFT 22
25 #define MLXSW_I2C_GO_BIT_SHIFT 23
26 #define MLXSW_I2C_CIR_CTRL_STATUS_SHIFT 24
27 #define MLXSW_I2C_EVENT_BIT BIT(MLXSW_I2C_EVENT_BIT_SHIFT)
28 #define MLXSW_I2C_GO_BIT BIT(MLXSW_I2C_GO_BIT_SHIFT)
29 #define MLXSW_I2C_GO_OPMODE BIT(MLXSW_I2C_OPMOD_SHIFT)
30 #define MLXSW_I2C_SET_IMM_CMD (MLXSW_I2C_GO_OPMODE | \
31 MLXSW_CMD_OPCODE_QUERY_FW)
32 #define MLXSW_I2C_PUSH_IMM_CMD (MLXSW_I2C_GO_BIT | \
33 MLXSW_I2C_SET_IMM_CMD)
34 #define MLXSW_I2C_SET_CMD (MLXSW_CMD_OPCODE_ACCESS_REG)
35 #define MLXSW_I2C_PUSH_CMD (MLXSW_I2C_GO_BIT | MLXSW_I2C_SET_CMD)
36 #define MLXSW_I2C_TLV_HDR_SIZE 0x10
37 #define MLXSW_I2C_ADDR_WIDTH 4
38 #define MLXSW_I2C_PUSH_CMD_SIZE (MLXSW_I2C_ADDR_WIDTH + 4)
39 #define MLXSW_I2C_SET_EVENT_CMD (MLXSW_I2C_EVENT_BIT)
40 #define MLXSW_I2C_PUSH_EVENT_CMD (MLXSW_I2C_GO_BIT | \
41 MLXSW_I2C_SET_EVENT_CMD)
42 #define MLXSW_I2C_READ_SEMA_SIZE 4
43 #define MLXSW_I2C_PREP_SIZE (MLXSW_I2C_ADDR_WIDTH + 28)
44 #define MLXSW_I2C_MBOX_SIZE 20
45 #define MLXSW_I2C_MBOX_OUT_PARAM_OFF 12
46 #define MLXSW_I2C_MBOX_OFFSET_BITS 20
47 #define MLXSW_I2C_MBOX_SIZE_BITS 12
48 #define MLXSW_I2C_ADDR_BUF_SIZE 4
49 #define MLXSW_I2C_BLK_DEF 32
50 #define MLXSW_I2C_RETRY 5
51 #define MLXSW_I2C_TIMEOUT_MSECS 5000
52 #define MLXSW_I2C_MAX_DATA_SIZE 256
55 * struct mlxsw_i2c - device private data:
56 * @cmd: command attributes;
57 * @cmd.mb_size_in: input mailbox size;
58 * @cmd.mb_off_in: input mailbox offset in register space;
59 * @cmd.mb_size_out: output mailbox size;
60 * @cmd.mb_off_out: output mailbox offset in register space;
61 * @cmd.lock: command execution lock;
63 * @core: switch core pointer;
64 * @bus_info: bus info block;
65 * @block_size: maximum block size allowed to pass to under layer;
76 struct mlxsw_core *core;
77 struct mlxsw_bus_info bus_info;
81 #define MLXSW_I2C_READ_MSG(_client, _addr_buf, _buf, _len) { \
82 { .addr = (_client)->addr, \
84 .len = MLXSW_I2C_ADDR_BUF_SIZE, \
86 { .addr = (_client)->addr, \
91 #define MLXSW_I2C_WRITE_MSG(_client, _buf, _len) \
92 { .addr = (_client)->addr, \
93 .buf = (u8 *)(_buf), \
97 /* Routine converts in and out mail boxes offset and size. */
99 mlxsw_i2c_convert_mbox(struct mlxsw_i2c *mlxsw_i2c, u8 *buf)
103 /* Local in/out mailboxes: 20 bits for offset, 12 for size */
104 tmp = be32_to_cpup((__be32 *) buf);
105 mlxsw_i2c->cmd.mb_off_in = tmp &
106 GENMASK(MLXSW_I2C_MBOX_OFFSET_BITS - 1, 0);
107 mlxsw_i2c->cmd.mb_size_in = (tmp & GENMASK(31,
108 MLXSW_I2C_MBOX_OFFSET_BITS)) >>
109 MLXSW_I2C_MBOX_OFFSET_BITS;
111 tmp = be32_to_cpup((__be32 *) (buf + MLXSW_I2C_ADDR_WIDTH));
112 mlxsw_i2c->cmd.mb_off_out = tmp &
113 GENMASK(MLXSW_I2C_MBOX_OFFSET_BITS - 1, 0);
114 mlxsw_i2c->cmd.mb_size_out = (tmp & GENMASK(31,
115 MLXSW_I2C_MBOX_OFFSET_BITS)) >>
116 MLXSW_I2C_MBOX_OFFSET_BITS;
119 /* Routine obtains register size from mail box buffer. */
120 static inline int mlxsw_i2c_get_reg_size(u8 *in_mbox)
122 u16 tmp = be16_to_cpup((__be16 *) (in_mbox + MLXSW_I2C_TLV_HDR_SIZE));
124 return (tmp & 0x7ff) * 4 + MLXSW_I2C_TLV_HDR_SIZE;
127 /* Routine sets I2C device internal offset in the transaction buffer. */
128 static inline void mlxsw_i2c_set_slave_addr(u8 *buf, u32 off)
130 __be32 *val = (__be32 *) buf;
135 /* Routine waits until go bit is cleared. */
136 static int mlxsw_i2c_wait_go_bit(struct i2c_client *client,
137 struct mlxsw_i2c *mlxsw_i2c, u8 *p_status)
139 u8 addr_buf[MLXSW_I2C_ADDR_BUF_SIZE];
140 u8 buf[MLXSW_I2C_READ_SEMA_SIZE];
141 int len = MLXSW_I2C_READ_SEMA_SIZE;
142 struct i2c_msg read_sema[] =
143 MLXSW_I2C_READ_MSG(client, addr_buf, buf, len);
144 bool wait_done = false;
148 mlxsw_i2c_set_slave_addr(addr_buf, MLXSW_I2C_CIR2_OFF_STATUS);
150 end = jiffies + msecs_to_jiffies(MLXSW_I2C_TIMEOUT_MSECS);
154 err = i2c_transfer(client->adapter, read_sema,
155 ARRAY_SIZE(read_sema));
157 ctrl = be32_to_cpu(*(__be32 *) buf);
158 if (err == ARRAY_SIZE(read_sema)) {
159 if (!(ctrl & MLXSW_I2C_GO_BIT)) {
162 MLXSW_I2C_CIR_CTRL_STATUS_SHIFT;
167 } while ((time_before(jiffies, end)) || (i++ < MLXSW_I2C_RETRY));
176 return err > 0 ? 0 : err;
179 /* Routine posts a command to ASIC through mail box. */
180 static int mlxsw_i2c_write_cmd(struct i2c_client *client,
181 struct mlxsw_i2c *mlxsw_i2c,
184 __be32 push_cmd_buf[MLXSW_I2C_PUSH_CMD_SIZE / 4] = {
185 0, cpu_to_be32(MLXSW_I2C_PUSH_IMM_CMD)
187 __be32 prep_cmd_buf[MLXSW_I2C_PREP_SIZE / 4] = {
189 cpu_to_be32(client->adapter->nr & 0xffff),
190 cpu_to_be32(MLXSW_I2C_SET_IMM_CMD)
192 struct i2c_msg push_cmd =
193 MLXSW_I2C_WRITE_MSG(client, push_cmd_buf,
194 MLXSW_I2C_PUSH_CMD_SIZE);
195 struct i2c_msg prep_cmd =
196 MLXSW_I2C_WRITE_MSG(client, prep_cmd_buf, MLXSW_I2C_PREP_SIZE);
200 push_cmd_buf[1] = cpu_to_be32(MLXSW_I2C_PUSH_CMD);
201 prep_cmd_buf[7] = cpu_to_be32(MLXSW_I2C_SET_CMD);
203 mlxsw_i2c_set_slave_addr((u8 *)prep_cmd_buf,
204 MLXSW_I2C_CIR2_BASE);
205 mlxsw_i2c_set_slave_addr((u8 *)push_cmd_buf,
206 MLXSW_I2C_CIR2_OFF_STATUS);
208 /* Prepare Command Interface Register for transaction */
209 err = i2c_transfer(client->adapter, &prep_cmd, 1);
215 /* Write out Command Interface Register GO bit to push transaction */
216 err = i2c_transfer(client->adapter, &push_cmd, 1);
225 /* Routine posts initialization command to ASIC through mail box. */
227 mlxsw_i2c_write_init_cmd(struct i2c_client *client,
228 struct mlxsw_i2c *mlxsw_i2c, u16 opcode, u32 in_mod)
230 __be32 push_cmd_buf[MLXSW_I2C_PUSH_CMD_SIZE / 4] = {
231 0, cpu_to_be32(MLXSW_I2C_PUSH_EVENT_CMD)
233 __be32 prep_cmd_buf[MLXSW_I2C_PREP_SIZE / 4] = {
235 cpu_to_be32(client->adapter->nr & 0xffff),
236 cpu_to_be32(MLXSW_I2C_SET_EVENT_CMD)
238 struct i2c_msg push_cmd =
239 MLXSW_I2C_WRITE_MSG(client, push_cmd_buf,
240 MLXSW_I2C_PUSH_CMD_SIZE);
241 struct i2c_msg prep_cmd =
242 MLXSW_I2C_WRITE_MSG(client, prep_cmd_buf, MLXSW_I2C_PREP_SIZE);
246 push_cmd_buf[1] = cpu_to_be32(MLXSW_I2C_PUSH_EVENT_CMD | opcode);
247 prep_cmd_buf[3] = cpu_to_be32(in_mod);
248 prep_cmd_buf[7] = cpu_to_be32(MLXSW_I2C_GO_BIT | opcode);
249 mlxsw_i2c_set_slave_addr((u8 *)prep_cmd_buf,
250 MLXSW_I2C_CIR2_BASE);
251 mlxsw_i2c_set_slave_addr((u8 *)push_cmd_buf,
252 MLXSW_I2C_CIR2_OFF_STATUS);
254 /* Prepare Command Interface Register for transaction */
255 err = i2c_transfer(client->adapter, &prep_cmd, 1);
261 /* Write out Command Interface Register GO bit to push transaction */
262 err = i2c_transfer(client->adapter, &push_cmd, 1);
268 /* Wait until go bit is cleared. */
269 err = mlxsw_i2c_wait_go_bit(client, mlxsw_i2c, &status);
271 dev_err(&client->dev, "HW semaphore is not released");
275 /* Validate transaction completion status. */
277 dev_err(&client->dev, "Bad transaction completion status %x\n",
285 /* Routine obtains mail box offsets from ASIC register space. */
286 static int mlxsw_i2c_get_mbox(struct i2c_client *client,
287 struct mlxsw_i2c *mlxsw_i2c)
289 u8 addr_buf[MLXSW_I2C_ADDR_BUF_SIZE];
290 u8 buf[MLXSW_I2C_MBOX_SIZE];
291 struct i2c_msg mbox_cmd[] =
292 MLXSW_I2C_READ_MSG(client, addr_buf, buf, MLXSW_I2C_MBOX_SIZE);
295 /* Read mail boxes offsets. */
296 mlxsw_i2c_set_slave_addr(addr_buf, MLXSW_I2C_CIR2_BASE);
297 err = i2c_transfer(client->adapter, mbox_cmd, 2);
299 dev_err(&client->dev, "Could not obtain mail boxes\n");
306 /* Convert mail boxes. */
307 mlxsw_i2c_convert_mbox(mlxsw_i2c, &buf[MLXSW_I2C_MBOX_OUT_PARAM_OFF]);
312 /* Routine sends I2C write transaction to ASIC device. */
314 mlxsw_i2c_write(struct device *dev, size_t in_mbox_size, u8 *in_mbox, int num,
317 struct i2c_client *client = to_i2c_client(dev);
318 struct mlxsw_i2c *mlxsw_i2c = i2c_get_clientdata(client);
319 unsigned long timeout = msecs_to_jiffies(MLXSW_I2C_TIMEOUT_MSECS);
320 int off = mlxsw_i2c->cmd.mb_off_in, chunk_size, i, j;
323 struct i2c_msg write_tran =
324 MLXSW_I2C_WRITE_MSG(client, NULL, MLXSW_I2C_PUSH_CMD_SIZE);
327 tran_buf = kmalloc(mlxsw_i2c->block_size + MLXSW_I2C_ADDR_BUF_SIZE,
332 write_tran.buf = tran_buf;
333 for (i = 0; i < num; i++) {
334 chunk_size = (in_mbox_size > mlxsw_i2c->block_size) ?
335 mlxsw_i2c->block_size : in_mbox_size;
336 write_tran.len = MLXSW_I2C_ADDR_WIDTH + chunk_size;
337 mlxsw_i2c_set_slave_addr(tran_buf, off);
338 memcpy(&tran_buf[MLXSW_I2C_ADDR_BUF_SIZE], in_mbox +
339 mlxsw_i2c->block_size * i, chunk_size);
342 end = jiffies + timeout;
344 err = i2c_transfer(client->adapter, &write_tran, 1);
349 } while ((time_before(jiffies, end)) ||
350 (j++ < MLXSW_I2C_RETRY));
355 goto mlxsw_i2c_write_exit;
360 in_mbox_size -= chunk_size;
363 /* Prepare and write out Command Interface Register for transaction. */
364 err = mlxsw_i2c_write_cmd(client, mlxsw_i2c, 0);
366 dev_err(&client->dev, "Could not start transaction");
368 goto mlxsw_i2c_write_exit;
371 /* Wait until go bit is cleared. */
372 err = mlxsw_i2c_wait_go_bit(client, mlxsw_i2c, p_status);
374 dev_err(&client->dev, "HW semaphore is not released");
375 goto mlxsw_i2c_write_exit;
378 /* Validate transaction completion status. */
380 dev_err(&client->dev, "Bad transaction completion status %x\n",
385 mlxsw_i2c_write_exit:
390 /* Routine executes I2C command. */
392 mlxsw_i2c_cmd(struct device *dev, u16 opcode, u32 in_mod, size_t in_mbox_size,
393 u8 *in_mbox, size_t out_mbox_size, u8 *out_mbox, u8 *status)
395 struct i2c_client *client = to_i2c_client(dev);
396 struct mlxsw_i2c *mlxsw_i2c = i2c_get_clientdata(client);
397 unsigned long timeout = msecs_to_jiffies(MLXSW_I2C_TIMEOUT_MSECS);
398 u8 tran_buf[MLXSW_I2C_ADDR_BUF_SIZE];
399 int num, chunk_size, reg_size, i, j;
400 int off = mlxsw_i2c->cmd.mb_off_out;
402 struct i2c_msg read_tran[] =
403 MLXSW_I2C_READ_MSG(client, tran_buf, NULL, 0);
406 WARN_ON(in_mbox_size % sizeof(u32) || out_mbox_size % sizeof(u32));
409 reg_size = mlxsw_i2c_get_reg_size(in_mbox);
410 num = reg_size / mlxsw_i2c->block_size;
411 if (reg_size % mlxsw_i2c->block_size)
414 if (mutex_lock_interruptible(&mlxsw_i2c->cmd.lock) < 0) {
415 dev_err(&client->dev, "Could not acquire lock");
419 err = mlxsw_i2c_write(dev, reg_size, in_mbox, num, status);
423 /* No out mailbox is case of write transaction. */
425 mutex_unlock(&mlxsw_i2c->cmd.lock);
429 /* No input mailbox is case of initialization query command. */
430 reg_size = MLXSW_I2C_MAX_DATA_SIZE;
431 num = reg_size / mlxsw_i2c->block_size;
433 if (mutex_lock_interruptible(&mlxsw_i2c->cmd.lock) < 0) {
434 dev_err(&client->dev, "Could not acquire lock");
438 err = mlxsw_i2c_write_init_cmd(client, mlxsw_i2c, opcode,
444 /* Send read transaction to get output mailbox content. */
445 read_tran[1].buf = out_mbox;
446 for (i = 0; i < num; i++) {
447 chunk_size = (reg_size > mlxsw_i2c->block_size) ?
448 mlxsw_i2c->block_size : reg_size;
449 read_tran[1].len = chunk_size;
450 mlxsw_i2c_set_slave_addr(tran_buf, off);
453 end = jiffies + timeout;
455 err = i2c_transfer(client->adapter, read_tran,
456 ARRAY_SIZE(read_tran));
457 if (err == ARRAY_SIZE(read_tran))
461 } while ((time_before(jiffies, end)) ||
462 (j++ < MLXSW_I2C_RETRY));
464 if (err != ARRAY_SIZE(read_tran)) {
472 reg_size -= chunk_size;
473 read_tran[1].buf += chunk_size;
476 mutex_unlock(&mlxsw_i2c->cmd.lock);
481 mutex_unlock(&mlxsw_i2c->cmd.lock);
485 static int mlxsw_i2c_cmd_exec(void *bus_priv, u16 opcode, u8 opcode_mod,
486 u32 in_mod, bool out_mbox_direct,
487 char *in_mbox, size_t in_mbox_size,
488 char *out_mbox, size_t out_mbox_size,
491 struct mlxsw_i2c *mlxsw_i2c = bus_priv;
493 return mlxsw_i2c_cmd(mlxsw_i2c->dev, opcode, in_mod, in_mbox_size,
494 in_mbox, out_mbox_size, out_mbox, status);
497 static bool mlxsw_i2c_skb_transmit_busy(void *bus_priv,
498 const struct mlxsw_tx_info *tx_info)
503 static int mlxsw_i2c_skb_transmit(void *bus_priv, struct sk_buff *skb,
504 const struct mlxsw_tx_info *tx_info)
510 mlxsw_i2c_init(void *bus_priv, struct mlxsw_core *mlxsw_core,
511 const struct mlxsw_config_profile *profile,
512 struct mlxsw_res *res)
514 struct mlxsw_i2c *mlxsw_i2c = bus_priv;
518 mlxsw_i2c->core = mlxsw_core;
520 mbox = mlxsw_cmd_mbox_alloc();
524 err = mlxsw_cmd_query_fw(mlxsw_core, mbox);
528 mlxsw_i2c->bus_info.fw_rev.major =
529 mlxsw_cmd_mbox_query_fw_fw_rev_major_get(mbox);
530 mlxsw_i2c->bus_info.fw_rev.minor =
531 mlxsw_cmd_mbox_query_fw_fw_rev_minor_get(mbox);
532 mlxsw_i2c->bus_info.fw_rev.subminor =
533 mlxsw_cmd_mbox_query_fw_fw_rev_subminor_get(mbox);
535 err = mlxsw_core_resources_query(mlxsw_core, mbox, res);
538 mlxsw_cmd_mbox_free(mbox);
542 static void mlxsw_i2c_fini(void *bus_priv)
544 struct mlxsw_i2c *mlxsw_i2c = bus_priv;
546 mlxsw_i2c->core = NULL;
549 static const struct mlxsw_bus mlxsw_i2c_bus = {
551 .init = mlxsw_i2c_init,
552 .fini = mlxsw_i2c_fini,
553 .skb_transmit_busy = mlxsw_i2c_skb_transmit_busy,
554 .skb_transmit = mlxsw_i2c_skb_transmit,
555 .cmd_exec = mlxsw_i2c_cmd_exec,
558 static int mlxsw_i2c_probe(struct i2c_client *client,
559 const struct i2c_device_id *id)
561 const struct i2c_adapter_quirks *quirks = client->adapter->quirks;
562 struct mlxsw_i2c *mlxsw_i2c;
566 mlxsw_i2c = devm_kzalloc(&client->dev, sizeof(*mlxsw_i2c), GFP_KERNEL);
571 if ((quirks->max_read_len &&
572 quirks->max_read_len < MLXSW_I2C_BLK_DEF) ||
573 (quirks->max_write_len &&
574 quirks->max_write_len < MLXSW_I2C_BLK_DEF)) {
575 dev_err(&client->dev, "Insufficient transaction buffer length\n");
579 mlxsw_i2c->block_size = max_t(u16, MLXSW_I2C_BLK_DEF,
580 min_t(u16, quirks->max_read_len,
581 quirks->max_write_len));
583 mlxsw_i2c->block_size = MLXSW_I2C_BLK_DEF;
586 i2c_set_clientdata(client, mlxsw_i2c);
587 mutex_init(&mlxsw_i2c->cmd.lock);
589 /* In order to use mailboxes through the i2c, special area is reserved
590 * on the i2c address space that can be used for input and output
591 * mailboxes. Such mailboxes are called local mailboxes. When using a
592 * local mailbox, software should specify 0 as the Input/Output
593 * parameters. The location of the Local Mailbox addresses on the i2c
594 * space can be retrieved through the QUERY_FW command.
595 * For this purpose QUERY_FW is to be issued with opcode modifier equal
596 * 0x01. For such command the output parameter is an immediate value.
597 * Here QUERY_FW command is invoked for ASIC probing and for getting
598 * local mailboxes addresses from immedate output parameters.
601 /* Prepare and write out Command Interface Register for transaction */
602 err = mlxsw_i2c_write_cmd(client, mlxsw_i2c, 1);
604 dev_err(&client->dev, "Could not start transaction");
608 /* Wait until go bit is cleared. */
609 err = mlxsw_i2c_wait_go_bit(client, mlxsw_i2c, &status);
611 dev_err(&client->dev, "HW semaphore is not released");
615 /* Validate transaction completion status. */
617 dev_err(&client->dev, "Bad transaction completion status %x\n",
623 /* Get mailbox offsets. */
624 err = mlxsw_i2c_get_mbox(client, mlxsw_i2c);
626 dev_err(&client->dev, "Fail to get mailboxes\n");
630 dev_info(&client->dev, "%s mb size=%x off=0x%08x out mb size=%x off=0x%08x\n",
631 id->name, mlxsw_i2c->cmd.mb_size_in,
632 mlxsw_i2c->cmd.mb_off_in, mlxsw_i2c->cmd.mb_size_out,
633 mlxsw_i2c->cmd.mb_off_out);
635 /* Register device bus. */
636 mlxsw_i2c->bus_info.device_kind = id->name;
637 mlxsw_i2c->bus_info.device_name = client->name;
638 mlxsw_i2c->bus_info.dev = &client->dev;
639 mlxsw_i2c->bus_info.low_frequency = true;
640 mlxsw_i2c->dev = &client->dev;
642 err = mlxsw_core_bus_device_register(&mlxsw_i2c->bus_info,
643 &mlxsw_i2c_bus, mlxsw_i2c, false,
646 dev_err(&client->dev, "Fail to register core bus\n");
653 i2c_set_clientdata(client, NULL);
658 static int mlxsw_i2c_remove(struct i2c_client *client)
660 struct mlxsw_i2c *mlxsw_i2c = i2c_get_clientdata(client);
662 mlxsw_core_bus_device_unregister(mlxsw_i2c->core, false);
663 mutex_destroy(&mlxsw_i2c->cmd.lock);
668 int mlxsw_i2c_driver_register(struct i2c_driver *i2c_driver)
670 i2c_driver->probe = mlxsw_i2c_probe;
671 i2c_driver->remove = mlxsw_i2c_remove;
672 return i2c_add_driver(i2c_driver);
674 EXPORT_SYMBOL(mlxsw_i2c_driver_register);
676 void mlxsw_i2c_driver_unregister(struct i2c_driver *i2c_driver)
678 i2c_del_driver(i2c_driver);
680 EXPORT_SYMBOL(mlxsw_i2c_driver_unregister);
682 MODULE_AUTHOR("Vadim Pasternak <vadimp@mellanox.com>");
683 MODULE_DESCRIPTION("Mellanox switch I2C interface driver");
684 MODULE_LICENSE("Dual BSD/GPL");