Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * Microchip ksz series register access through SPI
4 *
5 * Copyright (C) 2017 Microchip Technology Inc.
6 * Tristram Ha <Tristram.Ha@microchip.com>
7 */
8
9#include <asm/unaligned.h>
10
11#include <linux/delay.h>
12#include <linux/kernel.h>
13#include <linux/module.h>
14#include <linux/regmap.h>
15#include <linux/spi/spi.h>
16
17#include "ksz_common.h"
18
19#define KSZ8795_SPI_ADDR_SHIFT 12
20#define KSZ8795_SPI_ADDR_ALIGN 3
21#define KSZ8795_SPI_TURNAROUND_SHIFT 1
22
23#define KSZ8863_SPI_ADDR_SHIFT 8
24#define KSZ8863_SPI_ADDR_ALIGN 8
25#define KSZ8863_SPI_TURNAROUND_SHIFT 0
26
27#define KSZ9477_SPI_ADDR_SHIFT 24
28#define KSZ9477_SPI_ADDR_ALIGN 3
29#define KSZ9477_SPI_TURNAROUND_SHIFT 5
30
31KSZ_REGMAP_TABLE(ksz8795, 16, KSZ8795_SPI_ADDR_SHIFT,
32 KSZ8795_SPI_TURNAROUND_SHIFT, KSZ8795_SPI_ADDR_ALIGN);
33
34KSZ_REGMAP_TABLE(ksz8863, 16, KSZ8863_SPI_ADDR_SHIFT,
35 KSZ8863_SPI_TURNAROUND_SHIFT, KSZ8863_SPI_ADDR_ALIGN);
36
37KSZ_REGMAP_TABLE(ksz9477, 32, KSZ9477_SPI_ADDR_SHIFT,
38 KSZ9477_SPI_TURNAROUND_SHIFT, KSZ9477_SPI_ADDR_ALIGN);
39
40static int ksz_spi_probe(struct spi_device *spi)
41{
42 const struct regmap_config *regmap_config;
43 const struct ksz_chip_data *chip;
44 struct device *ddev = &spi->dev;
45 struct regmap_config rc;
46 struct ksz_device *dev;
47 int i, ret = 0;
48
49 dev = ksz_switch_alloc(&spi->dev, spi);
50 if (!dev)
51 return -ENOMEM;
52
53 chip = device_get_match_data(ddev);
54 if (!chip)
55 return -EINVAL;
56
57 if (chip->chip_id == KSZ8830_CHIP_ID)
58 regmap_config = ksz8863_regmap_config;
59 else if (chip->chip_id == KSZ8795_CHIP_ID ||
60 chip->chip_id == KSZ8794_CHIP_ID ||
61 chip->chip_id == KSZ8765_CHIP_ID)
62 regmap_config = ksz8795_regmap_config;
63 else
64 regmap_config = ksz9477_regmap_config;
65
66 for (i = 0; i < __KSZ_NUM_REGMAPS; i++) {
67 rc = regmap_config[i];
68 rc.lock_arg = &dev->regmap_mutex;
69 rc.wr_table = chip->wr_table;
70 rc.rd_table = chip->rd_table;
71 dev->regmap[i] = devm_regmap_init_spi(spi, &rc);
72
73 if (IS_ERR(dev->regmap[i])) {
74 return dev_err_probe(&spi->dev, PTR_ERR(dev->regmap[i]),
75 "Failed to initialize regmap%i\n",
76 regmap_config[i].val_bits);
77 }
78 }
79
80 if (spi->dev.platform_data)
81 dev->pdata = spi->dev.platform_data;
82
83 /* setup spi */
84 spi->mode = SPI_MODE_3;
85 ret = spi_setup(spi);
86 if (ret)
87 return ret;
88
89 dev->irq = spi->irq;
90
91 ret = ksz_switch_register(dev);
92
93 /* Main DSA driver may not be started yet. */
94 if (ret)
95 return ret;
96
97 spi_set_drvdata(spi, dev);
98
99 return 0;
100}
101
102static void ksz_spi_remove(struct spi_device *spi)
103{
104 struct ksz_device *dev = spi_get_drvdata(spi);
105
106 if (dev)
107 ksz_switch_remove(dev);
108}
109
110static void ksz_spi_shutdown(struct spi_device *spi)
111{
112 struct ksz_device *dev = spi_get_drvdata(spi);
113
114 if (!dev)
115 return;
116
117 ksz_switch_shutdown(dev);
118
119 spi_set_drvdata(spi, NULL);
120}
121
122static const struct of_device_id ksz_dt_ids[] = {
123 {
124 .compatible = "microchip,ksz8765",
125 .data = &ksz_switch_chips[KSZ8765]
126 },
127 {
128 .compatible = "microchip,ksz8794",
129 .data = &ksz_switch_chips[KSZ8794]
130 },
131 {
132 .compatible = "microchip,ksz8795",
133 .data = &ksz_switch_chips[KSZ8795]
134 },
135 {
136 .compatible = "microchip,ksz8863",
137 .data = &ksz_switch_chips[KSZ8830]
138 },
139 {
140 .compatible = "microchip,ksz8873",
141 .data = &ksz_switch_chips[KSZ8830]
142 },
143 {
144 .compatible = "microchip,ksz9477",
145 .data = &ksz_switch_chips[KSZ9477]
146 },
147 {
148 .compatible = "microchip,ksz9896",
149 .data = &ksz_switch_chips[KSZ9896]
150 },
151 {
152 .compatible = "microchip,ksz9897",
153 .data = &ksz_switch_chips[KSZ9897]
154 },
155 {
156 .compatible = "microchip,ksz9893",
157 .data = &ksz_switch_chips[KSZ9893]
158 },
159 {
160 .compatible = "microchip,ksz9563",
161 .data = &ksz_switch_chips[KSZ9563]
162 },
163 {
164 .compatible = "microchip,ksz8563",
165 .data = &ksz_switch_chips[KSZ8563]
166 },
167 {
168 .compatible = "microchip,ksz9567",
169 .data = &ksz_switch_chips[KSZ9567]
170 },
171 {
172 .compatible = "microchip,lan9370",
173 .data = &ksz_switch_chips[LAN9370]
174 },
175 {
176 .compatible = "microchip,lan9371",
177 .data = &ksz_switch_chips[LAN9371]
178 },
179 {
180 .compatible = "microchip,lan9372",
181 .data = &ksz_switch_chips[LAN9372]
182 },
183 {
184 .compatible = "microchip,lan9373",
185 .data = &ksz_switch_chips[LAN9373]
186 },
187 {
188 .compatible = "microchip,lan9374",
189 .data = &ksz_switch_chips[LAN9374]
190 },
191 {},
192};
193MODULE_DEVICE_TABLE(of, ksz_dt_ids);
194
195static const struct spi_device_id ksz_spi_ids[] = {
196 { "ksz8765" },
197 { "ksz8794" },
198 { "ksz8795" },
199 { "ksz8863" },
200 { "ksz8873" },
201 { "ksz9477" },
202 { "ksz9896" },
203 { "ksz9897" },
204 { "ksz9893" },
205 { "ksz9563" },
206 { "ksz8563" },
207 { "ksz9567" },
208 { "lan9370" },
209 { "lan9371" },
210 { "lan9372" },
211 { "lan9373" },
212 { "lan9374" },
213 { },
214};
215MODULE_DEVICE_TABLE(spi, ksz_spi_ids);
216
217static struct spi_driver ksz_spi_driver = {
218 .driver = {
219 .name = "ksz-switch",
220 .owner = THIS_MODULE,
221 .of_match_table = ksz_dt_ids,
222 },
223 .id_table = ksz_spi_ids,
224 .probe = ksz_spi_probe,
225 .remove = ksz_spi_remove,
226 .shutdown = ksz_spi_shutdown,
227};
228
229module_spi_driver(ksz_spi_driver);
230
231MODULE_ALIAS("spi:ksz9477");
232MODULE_ALIAS("spi:ksz9896");
233MODULE_ALIAS("spi:ksz9897");
234MODULE_ALIAS("spi:ksz9893");
235MODULE_ALIAS("spi:ksz9563");
236MODULE_ALIAS("spi:ksz8563");
237MODULE_ALIAS("spi:ksz9567");
238MODULE_ALIAS("spi:lan937x");
239MODULE_AUTHOR("Tristram Ha <Tristram.Ha@microchip.com>");
240MODULE_DESCRIPTION("Microchip ksz Series Switch SPI Driver");
241MODULE_LICENSE("GPL");
1/*
2 * Microchip KSZ series register access through SPI
3 *
4 * Copyright (C) 2017
5 *
6 * Permission to use, copy, modify, and/or distribute this software for any
7 * purpose with or without fee is hereby granted, provided that the above
8 * copyright notice and this permission notice appear in all copies.
9 *
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
17 */
18
19#include <asm/unaligned.h>
20
21#include <linux/delay.h>
22#include <linux/kernel.h>
23#include <linux/module.h>
24#include <linux/spi/spi.h>
25
26#include "ksz_priv.h"
27
28/* SPI frame opcodes */
29#define KS_SPIOP_RD 3
30#define KS_SPIOP_WR 2
31
32#define SPI_ADDR_SHIFT 24
33#define SPI_ADDR_MASK (BIT(SPI_ADDR_SHIFT) - 1)
34#define SPI_TURNAROUND_SHIFT 5
35
36static int ksz_spi_read_reg(struct spi_device *spi, u32 reg, u8 *val,
37 unsigned int len)
38{
39 u32 txbuf;
40 int ret;
41
42 txbuf = reg & SPI_ADDR_MASK;
43 txbuf |= KS_SPIOP_RD << SPI_ADDR_SHIFT;
44 txbuf <<= SPI_TURNAROUND_SHIFT;
45 txbuf = cpu_to_be32(txbuf);
46
47 ret = spi_write_then_read(spi, &txbuf, 4, val, len);
48 return ret;
49}
50
51static int ksz_spi_read(struct ksz_device *dev, u32 reg, u8 *data,
52 unsigned int len)
53{
54 struct spi_device *spi = dev->priv;
55
56 return ksz_spi_read_reg(spi, reg, data, len);
57}
58
59static int ksz_spi_read8(struct ksz_device *dev, u32 reg, u8 *val)
60{
61 return ksz_spi_read(dev, reg, val, 1);
62}
63
64static int ksz_spi_read16(struct ksz_device *dev, u32 reg, u16 *val)
65{
66 int ret = ksz_spi_read(dev, reg, (u8 *)val, 2);
67
68 if (!ret)
69 *val = be16_to_cpu(*val);
70
71 return ret;
72}
73
74static int ksz_spi_read24(struct ksz_device *dev, u32 reg, u32 *val)
75{
76 int ret;
77
78 *val = 0;
79 ret = ksz_spi_read(dev, reg, (u8 *)val, 3);
80 if (!ret) {
81 *val = be32_to_cpu(*val);
82 /* convert to 24bit */
83 *val >>= 8;
84 }
85
86 return ret;
87}
88
89static int ksz_spi_read32(struct ksz_device *dev, u32 reg, u32 *val)
90{
91 int ret = ksz_spi_read(dev, reg, (u8 *)val, 4);
92
93 if (!ret)
94 *val = be32_to_cpu(*val);
95
96 return ret;
97}
98
99static int ksz_spi_write_reg(struct spi_device *spi, u32 reg, u8 *val,
100 unsigned int len)
101{
102 u32 txbuf;
103 u8 data[12];
104 int i;
105
106 txbuf = reg & SPI_ADDR_MASK;
107 txbuf |= (KS_SPIOP_WR << SPI_ADDR_SHIFT);
108 txbuf <<= SPI_TURNAROUND_SHIFT;
109 txbuf = cpu_to_be32(txbuf);
110
111 data[0] = txbuf & 0xFF;
112 data[1] = (txbuf & 0xFF00) >> 8;
113 data[2] = (txbuf & 0xFF0000) >> 16;
114 data[3] = (txbuf & 0xFF000000) >> 24;
115 for (i = 0; i < len; i++)
116 data[i + 4] = val[i];
117
118 return spi_write(spi, &data, 4 + len);
119}
120
121static int ksz_spi_write8(struct ksz_device *dev, u32 reg, u8 value)
122{
123 struct spi_device *spi = dev->priv;
124
125 return ksz_spi_write_reg(spi, reg, &value, 1);
126}
127
128static int ksz_spi_write16(struct ksz_device *dev, u32 reg, u16 value)
129{
130 struct spi_device *spi = dev->priv;
131
132 value = cpu_to_be16(value);
133 return ksz_spi_write_reg(spi, reg, (u8 *)&value, 2);
134}
135
136static int ksz_spi_write24(struct ksz_device *dev, u32 reg, u32 value)
137{
138 struct spi_device *spi = dev->priv;
139
140 /* make it to big endian 24bit from MSB */
141 value <<= 8;
142 value = cpu_to_be32(value);
143 return ksz_spi_write_reg(spi, reg, (u8 *)&value, 3);
144}
145
146static int ksz_spi_write32(struct ksz_device *dev, u32 reg, u32 value)
147{
148 struct spi_device *spi = dev->priv;
149
150 value = cpu_to_be32(value);
151 return ksz_spi_write_reg(spi, reg, (u8 *)&value, 4);
152}
153
154static const struct ksz_io_ops ksz_spi_ops = {
155 .read8 = ksz_spi_read8,
156 .read16 = ksz_spi_read16,
157 .read24 = ksz_spi_read24,
158 .read32 = ksz_spi_read32,
159 .write8 = ksz_spi_write8,
160 .write16 = ksz_spi_write16,
161 .write24 = ksz_spi_write24,
162 .write32 = ksz_spi_write32,
163};
164
165static int ksz_spi_probe(struct spi_device *spi)
166{
167 struct ksz_device *dev;
168 int ret;
169
170 dev = ksz_switch_alloc(&spi->dev, &ksz_spi_ops, spi);
171 if (!dev)
172 return -ENOMEM;
173
174 if (spi->dev.platform_data)
175 dev->pdata = spi->dev.platform_data;
176
177 ret = ksz_switch_register(dev);
178 if (ret)
179 return ret;
180
181 spi_set_drvdata(spi, dev);
182
183 return 0;
184}
185
186static int ksz_spi_remove(struct spi_device *spi)
187{
188 struct ksz_device *dev = spi_get_drvdata(spi);
189
190 if (dev)
191 ksz_switch_remove(dev);
192
193 return 0;
194}
195
196static const struct of_device_id ksz_dt_ids[] = {
197 { .compatible = "microchip,ksz9477" },
198 {},
199};
200MODULE_DEVICE_TABLE(of, ksz_dt_ids);
201
202static struct spi_driver ksz_spi_driver = {
203 .driver = {
204 .name = "ksz9477-switch",
205 .owner = THIS_MODULE,
206 .of_match_table = of_match_ptr(ksz_dt_ids),
207 },
208 .probe = ksz_spi_probe,
209 .remove = ksz_spi_remove,
210};
211
212module_spi_driver(ksz_spi_driver);
213
214MODULE_AUTHOR("Woojung Huh <Woojung.Huh@microchip.com>");
215MODULE_DESCRIPTION("Microchip KSZ Series Switch SPI access Driver");
216MODULE_LICENSE("GPL");