blob: 7fc9a2c66396dbdbe1ed508d5240ee186e238db4 [file] [log] [blame]
Mingkai Hu8b60d6c2010-10-12 18:18:32 +08001/*
2 * Freescale eSPI controller driver.
3 *
4 * Copyright 2010 Freescale Semiconductor, Inc.
5 *
6 * This program is free software; you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the
8 * Free Software Foundation; either version 2 of the License, or (at your
9 * option) any later version.
10 */
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080011#include <linux/delay.h>
Xiubo Lia3108362014-09-29 10:57:06 +080012#include <linux/err.h>
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080013#include <linux/fsl_devices.h>
Xiubo Lia3108362014-09-29 10:57:06 +080014#include <linux/interrupt.h>
Xiubo Lia3108362014-09-29 10:57:06 +080015#include <linux/module.h>
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080016#include <linux/mm.h>
17#include <linux/of.h>
Rob Herring5af50732013-09-17 14:28:33 -050018#include <linux/of_address.h>
19#include <linux/of_irq.h>
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080020#include <linux/of_platform.h>
Xiubo Lia3108362014-09-29 10:57:06 +080021#include <linux/platform_device.h>
22#include <linux/spi/spi.h>
Heiner Kallweite9abb4d2015-08-26 21:21:55 +020023#include <linux/pm_runtime.h>
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080024#include <sysdev/fsl_soc.h>
25
Grant Likelyca632f52011-06-06 01:16:30 -060026#include "spi-fsl-lib.h"
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080027
28/* eSPI Controller registers */
29struct fsl_espi_reg {
30 __be32 mode; /* 0x000 - eSPI mode register */
31 __be32 event; /* 0x004 - eSPI event register */
32 __be32 mask; /* 0x008 - eSPI mask register */
33 __be32 command; /* 0x00c - eSPI command register */
34 __be32 transmit; /* 0x010 - eSPI transmit FIFO access register*/
35 __be32 receive; /* 0x014 - eSPI receive FIFO access register*/
36 u8 res[8]; /* 0x018 - 0x01c reserved */
37 __be32 csmode[4]; /* 0x020 - 0x02c eSPI cs mode register */
38};
39
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080040/* eSPI Controller mode register definitions */
41#define SPMODE_ENABLE (1 << 31)
42#define SPMODE_LOOP (1 << 30)
43#define SPMODE_TXTHR(x) ((x) << 8)
44#define SPMODE_RXTHR(x) ((x) << 0)
45
46/* eSPI Controller CS mode register definitions */
47#define CSMODE_CI_INACTIVEHIGH (1 << 31)
48#define CSMODE_CP_BEGIN_EDGECLK (1 << 30)
49#define CSMODE_REV (1 << 29)
50#define CSMODE_DIV16 (1 << 28)
51#define CSMODE_PM(x) ((x) << 24)
52#define CSMODE_POL_1 (1 << 20)
53#define CSMODE_LEN(x) ((x) << 16)
54#define CSMODE_BEF(x) ((x) << 12)
55#define CSMODE_AFT(x) ((x) << 8)
56#define CSMODE_CG(x) ((x) << 3)
57
58/* Default mode/csmode for eSPI controller */
59#define SPMODE_INIT_VAL (SPMODE_TXTHR(4) | SPMODE_RXTHR(3))
60#define CSMODE_INIT_VAL (CSMODE_POL_1 | CSMODE_BEF(0) \
61 | CSMODE_AFT(0) | CSMODE_CG(1))
62
63/* SPIE register values */
64#define SPIE_NE 0x00000200 /* Not empty */
65#define SPIE_NF 0x00000100 /* Not full */
66
67/* SPIM register values */
68#define SPIM_NE 0x00000200 /* Not empty */
69#define SPIM_NF 0x00000100 /* Not full */
70#define SPIE_RXCNT(reg) ((reg >> 24) & 0x3F)
71#define SPIE_TXCNT(reg) ((reg >> 16) & 0x3F)
72
73/* SPCOM register values */
74#define SPCOM_CS(x) ((x) << 30)
75#define SPCOM_TRANLEN(x) ((x) << 0)
Hou Zhiqiang5cfa1e42016-01-22 18:58:26 +080076#define SPCOM_TRANLEN_MAX 0x10000 /* Max transaction length */
Mingkai Hu8b60d6c2010-10-12 18:18:32 +080077
Heiner Kallweite9abb4d2015-08-26 21:21:55 +020078#define AUTOSUSPEND_TIMEOUT 2000
79
Heiner Kallweit7c159aa2016-09-07 22:50:53 +020080static unsigned int fsl_espi_copy_to_buf(struct spi_message *m,
81 struct mpc8xxx_spi *mspi)
82{
83 unsigned int tx_only = 0;
84 struct spi_transfer *t;
85 u8 *buf = mspi->local_buf;
86
87 list_for_each_entry(t, &m->transfers, transfer_list) {
88 if (t->tx_buf) {
89 memcpy(buf, t->tx_buf, t->len);
90 if (!t->rx_buf)
91 tx_only += t->len;
92 } else {
93 memset(buf, 0, t->len);
94 }
95 buf += t->len;
96 }
97
98 return tx_only;
99}
100
Heiner Kallweitd3152cf12016-09-07 22:53:38 +0200101static int fsl_espi_check_message(struct spi_message *m)
102{
103 struct mpc8xxx_spi *mspi = spi_master_get_devdata(m->spi->master);
104 struct spi_transfer *t, *first;
105
106 if (m->frame_length > SPCOM_TRANLEN_MAX) {
107 dev_err(mspi->dev, "message too long, size is %u bytes\n",
108 m->frame_length);
109 return -EMSGSIZE;
110 }
111
112 first = list_first_entry(&m->transfers, struct spi_transfer,
113 transfer_list);
114 list_for_each_entry(t, &m->transfers, transfer_list) {
115 if (first->bits_per_word != t->bits_per_word ||
116 first->speed_hz != t->speed_hz) {
117 dev_err(mspi->dev, "bits_per_word/speed_hz should be the same for all transfers\n");
118 return -EINVAL;
119 }
120 }
121
122 return 0;
123}
124
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800125static void fsl_espi_change_mode(struct spi_device *spi)
126{
127 struct mpc8xxx_spi *mspi = spi_master_get_devdata(spi->master);
128 struct spi_mpc8xxx_cs *cs = spi->controller_state;
129 struct fsl_espi_reg *reg_base = mspi->reg_base;
130 __be32 __iomem *mode = &reg_base->csmode[spi->chip_select];
131 __be32 __iomem *espi_mode = &reg_base->mode;
132 u32 tmp;
133 unsigned long flags;
134
135 /* Turn off IRQs locally to minimize time that SPI is disabled. */
136 local_irq_save(flags);
137
138 /* Turn off SPI unit prior changing mode */
139 tmp = mpc8xxx_spi_read_reg(espi_mode);
140 mpc8xxx_spi_write_reg(espi_mode, tmp & ~SPMODE_ENABLE);
141 mpc8xxx_spi_write_reg(mode, cs->hw_mode);
142 mpc8xxx_spi_write_reg(espi_mode, tmp);
143
144 local_irq_restore(flags);
145}
146
147static u32 fsl_espi_tx_buf_lsb(struct mpc8xxx_spi *mpc8xxx_spi)
148{
149 u32 data;
150 u16 data_h;
151 u16 data_l;
152 const u32 *tx = mpc8xxx_spi->tx;
153
154 if (!tx)
155 return 0;
156
157 data = *tx++ << mpc8xxx_spi->tx_shift;
158 data_l = data & 0xffff;
159 data_h = (data >> 16) & 0xffff;
160 swab16s(&data_l);
161 swab16s(&data_h);
162 data = data_h | data_l;
163
164 mpc8xxx_spi->tx = tx;
165 return data;
166}
167
Heiner Kallweitea616ee2016-08-25 06:44:42 +0200168static void fsl_espi_setup_transfer(struct spi_device *spi,
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800169 struct spi_transfer *t)
170{
171 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
172 int bits_per_word = 0;
173 u8 pm;
174 u32 hz = 0;
175 struct spi_mpc8xxx_cs *cs = spi->controller_state;
176
177 if (t) {
178 bits_per_word = t->bits_per_word;
179 hz = t->speed_hz;
180 }
181
182 /* spi_transfer level calls that work per-word */
183 if (!bits_per_word)
184 bits_per_word = spi->bits_per_word;
185
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800186 if (!hz)
187 hz = spi->max_speed_hz;
188
189 cs->rx_shift = 0;
190 cs->tx_shift = 0;
191 cs->get_rx = mpc8xxx_spi_rx_buf_u32;
192 cs->get_tx = mpc8xxx_spi_tx_buf_u32;
193 if (bits_per_word <= 8) {
194 cs->rx_shift = 8 - bits_per_word;
Stephen Warren51faed62013-05-30 09:59:41 -0600195 } else {
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800196 cs->rx_shift = 16 - bits_per_word;
197 if (spi->mode & SPI_LSB_FIRST)
198 cs->get_tx = fsl_espi_tx_buf_lsb;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800199 }
200
201 mpc8xxx_spi->rx_shift = cs->rx_shift;
202 mpc8xxx_spi->tx_shift = cs->tx_shift;
203 mpc8xxx_spi->get_rx = cs->get_rx;
204 mpc8xxx_spi->get_tx = cs->get_tx;
205
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800206 /* mask out bits we are going to set */
207 cs->hw_mode &= ~(CSMODE_LEN(0xF) | CSMODE_DIV16 | CSMODE_PM(0xF));
208
Heiner Kallweita755af52016-09-04 09:56:57 +0200209 cs->hw_mode |= CSMODE_LEN(bits_per_word - 1);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800210
211 if ((mpc8xxx_spi->spibrg / hz) > 64) {
212 cs->hw_mode |= CSMODE_DIV16;
Sebastian Andrzej Siewior35faa552012-03-15 18:42:31 +0100213 pm = DIV_ROUND_UP(mpc8xxx_spi->spibrg, hz * 16 * 4);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800214
Sebastian Andrzej Siewior87bf5ab2012-03-15 18:42:32 +0100215 WARN_ONCE(pm > 33, "%s: Requested speed is too low: %d Hz. "
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800216 "Will use %d Hz instead.\n", dev_name(&spi->dev),
Sebastian Andrzej Siewior87bf5ab2012-03-15 18:42:32 +0100217 hz, mpc8xxx_spi->spibrg / (4 * 16 * (32 + 1)));
218 if (pm > 33)
219 pm = 33;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800220 } else {
Sebastian Andrzej Siewior35faa552012-03-15 18:42:31 +0100221 pm = DIV_ROUND_UP(mpc8xxx_spi->spibrg, hz * 4);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800222 }
223 if (pm)
224 pm--;
Sebastian Andrzej Siewior87bf5ab2012-03-15 18:42:32 +0100225 if (pm < 2)
226 pm = 2;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800227
228 cs->hw_mode |= CSMODE_PM(pm);
229
230 fsl_espi_change_mode(spi);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800231}
232
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800233static int fsl_espi_bufs(struct spi_device *spi, struct spi_transfer *t)
234{
235 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(spi->master);
236 struct fsl_espi_reg *reg_base = mpc8xxx_spi->reg_base;
Heiner Kallweit5bcc6a22016-09-07 22:53:01 +0200237 u32 word;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800238 int ret;
239
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800240 mpc8xxx_spi->len = t->len;
Heiner Kallweit5bcc6a22016-09-07 22:53:01 +0200241 mpc8xxx_spi->count = roundup(t->len, 4) / 4;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800242
243 mpc8xxx_spi->tx = t->tx_buf;
244 mpc8xxx_spi->rx = t->rx_buf;
245
Wolfram Sang16735d02013-11-14 14:32:02 -0800246 reinit_completion(&mpc8xxx_spi->done);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800247
248 /* Set SPCOM[CS] and SPCOM[TRANLEN] field */
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800249 mpc8xxx_spi_write_reg(&reg_base->command,
250 (SPCOM_CS(spi->chip_select) | SPCOM_TRANLEN(t->len - 1)));
251
Heiner Kallweit5bcc6a22016-09-07 22:53:01 +0200252 /* enable rx ints */
253 mpc8xxx_spi_write_reg(&reg_base->mask, SPIM_NE);
254
255 /* transmit word */
256 word = mpc8xxx_spi->get_tx(mpc8xxx_spi);
257 mpc8xxx_spi_write_reg(&reg_base->transmit, word);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800258
Nobuteru Hayashiaa70e562016-03-18 11:35:21 +0000259 /* Won't hang up forever, SPI bus sometimes got lost interrupts... */
260 ret = wait_for_completion_timeout(&mpc8xxx_spi->done, 2 * HZ);
261 if (ret == 0)
262 dev_err(mpc8xxx_spi->dev,
263 "Transaction hanging up (left %d bytes)\n",
264 mpc8xxx_spi->count);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800265
266 /* disable rx ints */
267 mpc8xxx_spi_write_reg(&reg_base->mask, 0);
268
Heiner Kallweit84ccfc32016-09-07 22:52:43 +0200269 return mpc8xxx_spi->count > 0 ? -EMSGSIZE : 0;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800270}
271
Heiner Kallweitfaceef32016-09-07 22:52:06 +0200272static int fsl_espi_do_trans(struct spi_message *m, struct spi_transfer *trans)
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800273{
274 struct spi_device *spi = m->spi;
Heiner Kallweite33a3ad2016-09-07 22:51:10 +0200275 int ret = 0;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800276
Heiner Kallweitfaceef32016-09-07 22:52:06 +0200277 fsl_espi_setup_transfer(spi, trans);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800278
Heiner Kallweitfaceef32016-09-07 22:52:06 +0200279 if (trans->len)
280 ret = fsl_espi_bufs(spi, trans);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800281
Heiner Kallweitfaceef32016-09-07 22:52:06 +0200282 if (trans->delay_usecs)
283 udelay(trans->delay_usecs);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800284
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800285 fsl_espi_setup_transfer(spi, NULL);
Heiner Kallweite33a3ad2016-09-07 22:51:10 +0200286
287 return ret;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800288}
289
Heiner Kallweit809b1e02016-09-07 22:52:25 +0200290static int fsl_espi_trans(struct spi_message *m, struct spi_transfer *trans,
291 u8 *rx_buff)
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800292{
Heiner Kallweit14238772016-09-07 22:50:22 +0200293 struct mpc8xxx_spi *mspi = spi_master_get_devdata(m->spi->master);
Heiner Kallweit7c159aa2016-09-07 22:50:53 +0200294 unsigned int tx_only;
Heiner Kallweite33a3ad2016-09-07 22:51:10 +0200295 int ret;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800296
Heiner Kallweit7c159aa2016-09-07 22:50:53 +0200297 tx_only = fsl_espi_copy_to_buf(m, mspi);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800298
Heiner Kallweite33a3ad2016-09-07 22:51:10 +0200299 ret = fsl_espi_do_trans(m, trans);
Jonatas Rech20000582015-04-15 12:23:18 -0300300
Heiner Kallweit809b1e02016-09-07 22:52:25 +0200301 /* If there is at least one RX byte then copy it to rx_buff */
302 if (!ret && rx_buff && trans->len > tx_only)
303 memcpy(rx_buff, trans->rx_buf + tx_only, trans->len - tx_only);
Heiner Kallweite33a3ad2016-09-07 22:51:10 +0200304
305 return ret;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800306}
307
Heiner Kallweitc592bec2014-12-03 07:56:17 +0100308static int fsl_espi_do_one_msg(struct spi_master *master,
309 struct spi_message *m)
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800310{
Heiner Kallweit96361faf2016-09-07 22:54:00 +0200311 struct mpc8xxx_spi *mspi = spi_master_get_devdata(m->spi->master);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800312 u8 *rx_buf = NULL;
Heiner Kallweit96361faf2016-09-07 22:54:00 +0200313 unsigned int delay_usecs = 0, xfer_len = 0;
Heiner Kallweitfaceef32016-09-07 22:52:06 +0200314 struct spi_transfer *t, trans = {};
Heiner Kallweite33a3ad2016-09-07 22:51:10 +0200315 int ret;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800316
Heiner Kallweitd3152cf12016-09-07 22:53:38 +0200317 ret = fsl_espi_check_message(m);
318 if (ret)
319 goto out;
320
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800321 list_for_each_entry(t, &m->transfers, transfer_list) {
Heiner Kallweitdaae0202016-09-04 09:53:01 +0200322 if (t->rx_buf)
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800323 rx_buf = t->rx_buf;
Jonatas Rech20000582015-04-15 12:23:18 -0300324 if ((t->tx_buf) || (t->rx_buf))
325 xfer_len += t->len;
Heiner Kallweit96361faf2016-09-07 22:54:00 +0200326 if (t->delay_usecs > delay_usecs)
327 delay_usecs = t->delay_usecs;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800328 }
329
Heiner Kallweit96361faf2016-09-07 22:54:00 +0200330 t = list_first_entry(&m->transfers, struct spi_transfer,
331 transfer_list);
332
Heiner Kallweitfaceef32016-09-07 22:52:06 +0200333 trans.len = xfer_len;
Heiner Kallweit96361faf2016-09-07 22:54:00 +0200334 trans.speed_hz = t->speed_hz;
335 trans.bits_per_word = t->bits_per_word;
336 trans.delay_usecs = delay_usecs;
337 trans.tx_buf = mspi->local_buf;
338 trans.rx_buf = mspi->local_buf;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800339
Heiner Kallweit809b1e02016-09-07 22:52:25 +0200340 ret = fsl_espi_trans(m, &trans, rx_buf);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800341
Heiner Kallweitfaceef32016-09-07 22:52:06 +0200342 m->actual_length = ret ? 0 : trans.len;
Heiner Kallweitd3152cf12016-09-07 22:53:38 +0200343out:
Heiner Kallweit0319d492016-09-07 22:51:29 +0200344 if (m->status == -EINPROGRESS)
345 m->status = ret;
346
Heiner Kallweitc592bec2014-12-03 07:56:17 +0100347 spi_finalize_current_message(master);
Heiner Kallweit0319d492016-09-07 22:51:29 +0200348
349 return ret;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800350}
351
352static int fsl_espi_setup(struct spi_device *spi)
353{
354 struct mpc8xxx_spi *mpc8xxx_spi;
355 struct fsl_espi_reg *reg_base;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800356 u32 hw_mode;
357 u32 loop_mode;
Axel Lind9f26742014-08-31 12:44:09 +0800358 struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800359
360 if (!spi->max_speed_hz)
361 return -EINVAL;
362
363 if (!cs) {
Axel Lind9f26742014-08-31 12:44:09 +0800364 cs = kzalloc(sizeof(*cs), GFP_KERNEL);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800365 if (!cs)
366 return -ENOMEM;
Axel Lind9f26742014-08-31 12:44:09 +0800367 spi_set_ctldata(spi, cs);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800368 }
369
370 mpc8xxx_spi = spi_master_get_devdata(spi->master);
371 reg_base = mpc8xxx_spi->reg_base;
372
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200373 pm_runtime_get_sync(mpc8xxx_spi->dev);
374
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300375 hw_mode = cs->hw_mode; /* Save original settings */
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800376 cs->hw_mode = mpc8xxx_spi_read_reg(
377 &reg_base->csmode[spi->chip_select]);
378 /* mask out bits we are going to set */
379 cs->hw_mode &= ~(CSMODE_CP_BEGIN_EDGECLK | CSMODE_CI_INACTIVEHIGH
380 | CSMODE_REV);
381
382 if (spi->mode & SPI_CPHA)
383 cs->hw_mode |= CSMODE_CP_BEGIN_EDGECLK;
384 if (spi->mode & SPI_CPOL)
385 cs->hw_mode |= CSMODE_CI_INACTIVEHIGH;
386 if (!(spi->mode & SPI_LSB_FIRST))
387 cs->hw_mode |= CSMODE_REV;
388
389 /* Handle the loop mode */
390 loop_mode = mpc8xxx_spi_read_reg(&reg_base->mode);
391 loop_mode &= ~SPMODE_LOOP;
392 if (spi->mode & SPI_LOOP)
393 loop_mode |= SPMODE_LOOP;
394 mpc8xxx_spi_write_reg(&reg_base->mode, loop_mode);
395
Heiner Kallweitea616ee2016-08-25 06:44:42 +0200396 fsl_espi_setup_transfer(spi, NULL);
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200397
398 pm_runtime_mark_last_busy(mpc8xxx_spi->dev);
399 pm_runtime_put_autosuspend(mpc8xxx_spi->dev);
400
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800401 return 0;
402}
403
Axel Lind9f26742014-08-31 12:44:09 +0800404static void fsl_espi_cleanup(struct spi_device *spi)
405{
406 struct spi_mpc8xxx_cs *cs = spi_get_ctldata(spi);
407
408 kfree(cs);
409 spi_set_ctldata(spi, NULL);
410}
411
Heiner Kallweit10ed1e62016-08-25 06:45:16 +0200412static void fsl_espi_cpu_irq(struct mpc8xxx_spi *mspi, u32 events)
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800413{
414 struct fsl_espi_reg *reg_base = mspi->reg_base;
415
416 /* We need handle RX first */
417 if (events & SPIE_NE) {
Mingkai Hue6289d62010-12-21 09:26:07 +0800418 u32 rx_data, tmp;
419 u8 rx_data_8;
Nobuteru Hayashi6319a682016-03-18 11:35:21 +0000420 int rx_nr_bytes = 4;
Nobuteru Hayashia12ddd62016-03-18 11:35:21 +0000421 int ret;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800422
423 /* Spin until RX is done */
Nobuteru Hayashia12ddd62016-03-18 11:35:21 +0000424 if (SPIE_RXCNT(events) < min(4, mspi->len)) {
425 ret = spin_event_timeout(
426 !(SPIE_RXCNT(events =
427 mpc8xxx_spi_read_reg(&reg_base->event)) <
428 min(4, mspi->len)),
429 10000, 0); /* 10 msec */
430 if (!ret)
431 dev_err(mspi->dev,
432 "tired waiting for SPIE_RXCNT\n");
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800433 }
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800434
Mingkai Hue6289d62010-12-21 09:26:07 +0800435 if (mspi->len >= 4) {
436 rx_data = mpc8xxx_spi_read_reg(&reg_base->receive);
Nobuteru Hayashi6319a682016-03-18 11:35:21 +0000437 } else if (mspi->len <= 0) {
438 dev_err(mspi->dev,
439 "unexpected RX(SPIE_NE) interrupt occurred,\n"
440 "(local rxlen %d bytes, reg rxlen %d bytes)\n",
441 min(4, mspi->len), SPIE_RXCNT(events));
442 rx_nr_bytes = 0;
Mingkai Hue6289d62010-12-21 09:26:07 +0800443 } else {
Nobuteru Hayashi6319a682016-03-18 11:35:21 +0000444 rx_nr_bytes = mspi->len;
Mingkai Hue6289d62010-12-21 09:26:07 +0800445 tmp = mspi->len;
446 rx_data = 0;
447 while (tmp--) {
448 rx_data_8 = in_8((u8 *)&reg_base->receive);
449 rx_data |= (rx_data_8 << (tmp * 8));
450 }
451
452 rx_data <<= (4 - mspi->len) * 8;
453 }
454
Nobuteru Hayashi6319a682016-03-18 11:35:21 +0000455 mspi->len -= rx_nr_bytes;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800456
457 if (mspi->rx)
458 mspi->get_rx(rx_data, mspi);
459 }
460
461 if (!(events & SPIE_NF)) {
462 int ret;
463
464 /* spin until TX is done */
465 ret = spin_event_timeout(((events = mpc8xxx_spi_read_reg(
Jane Wan7a0a1752015-05-01 16:37:42 -0700466 &reg_base->event)) & SPIE_NF), 1000, 0);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800467 if (!ret) {
468 dev_err(mspi->dev, "tired waiting for SPIE_NF\n");
Jane Wan7a0a1752015-05-01 16:37:42 -0700469
470 /* Clear the SPIE bits */
471 mpc8xxx_spi_write_reg(&reg_base->event, events);
472 complete(&mspi->done);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800473 return;
474 }
475 }
476
477 /* Clear the events */
478 mpc8xxx_spi_write_reg(&reg_base->event, events);
479
480 mspi->count -= 1;
481 if (mspi->count) {
482 u32 word = mspi->get_tx(mspi);
483
484 mpc8xxx_spi_write_reg(&reg_base->transmit, word);
485 } else {
486 complete(&mspi->done);
487 }
488}
489
490static irqreturn_t fsl_espi_irq(s32 irq, void *context_data)
491{
492 struct mpc8xxx_spi *mspi = context_data;
493 struct fsl_espi_reg *reg_base = mspi->reg_base;
494 irqreturn_t ret = IRQ_NONE;
495 u32 events;
496
497 /* Get interrupt events(tx/rx) */
498 events = mpc8xxx_spi_read_reg(&reg_base->event);
499 if (events)
500 ret = IRQ_HANDLED;
501
502 dev_vdbg(mspi->dev, "%s: events %x\n", __func__, events);
503
504 fsl_espi_cpu_irq(mspi, events);
505
506 return ret;
507}
508
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200509#ifdef CONFIG_PM
510static int fsl_espi_runtime_suspend(struct device *dev)
Heiner Kallweit75506d02014-12-03 07:56:19 +0100511{
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200512 struct spi_master *master = dev_get_drvdata(dev);
513 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
514 struct fsl_espi_reg *reg_base = mpc8xxx_spi->reg_base;
Heiner Kallweit75506d02014-12-03 07:56:19 +0100515 u32 regval;
516
Heiner Kallweit75506d02014-12-03 07:56:19 +0100517 regval = mpc8xxx_spi_read_reg(&reg_base->mode);
518 regval &= ~SPMODE_ENABLE;
519 mpc8xxx_spi_write_reg(&reg_base->mode, regval);
520
521 return 0;
522}
523
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200524static int fsl_espi_runtime_resume(struct device *dev)
Heiner Kallweit75506d02014-12-03 07:56:19 +0100525{
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200526 struct spi_master *master = dev_get_drvdata(dev);
527 struct mpc8xxx_spi *mpc8xxx_spi = spi_master_get_devdata(master);
528 struct fsl_espi_reg *reg_base = mpc8xxx_spi->reg_base;
Heiner Kallweit75506d02014-12-03 07:56:19 +0100529 u32 regval;
530
Heiner Kallweit75506d02014-12-03 07:56:19 +0100531 regval = mpc8xxx_spi_read_reg(&reg_base->mode);
532 regval |= SPMODE_ENABLE;
533 mpc8xxx_spi_write_reg(&reg_base->mode, regval);
534
535 return 0;
536}
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200537#endif
Heiner Kallweit75506d02014-12-03 07:56:19 +0100538
Heiner Kallweit02a595d2016-08-17 21:11:01 +0200539static size_t fsl_espi_max_message_size(struct spi_device *spi)
Michal Suchanekb541eef2015-12-02 10:38:21 +0000540{
541 return SPCOM_TRANLEN_MAX;
542}
543
Grant Likelyfd4a3192012-12-07 16:57:14 +0000544static struct spi_master * fsl_espi_probe(struct device *dev,
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800545 struct resource *mem, unsigned int irq)
546{
Jingoo Han8074cf02013-07-30 16:58:59 +0900547 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800548 struct spi_master *master;
549 struct mpc8xxx_spi *mpc8xxx_spi;
550 struct fsl_espi_reg *reg_base;
Jane Wand0fb47a52014-04-16 13:09:39 -0700551 struct device_node *nc;
552 const __be32 *prop;
553 u32 regval, csmode;
554 int i, len, ret = 0;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800555
556 master = spi_alloc_master(dev, sizeof(struct mpc8xxx_spi));
557 if (!master) {
558 ret = -ENOMEM;
559 goto err;
560 }
561
562 dev_set_drvdata(dev, master);
563
Heiner Kallweitc592bec2014-12-03 07:56:17 +0100564 mpc8xxx_spi_probe(dev, mem, irq);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800565
Stephen Warren24778be2013-05-21 20:36:35 -0600566 master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 16);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800567 master->setup = fsl_espi_setup;
Axel Lind9f26742014-08-31 12:44:09 +0800568 master->cleanup = fsl_espi_cleanup;
Heiner Kallweitc592bec2014-12-03 07:56:17 +0100569 master->transfer_one_message = fsl_espi_do_one_msg;
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200570 master->auto_runtime_pm = true;
Heiner Kallweit02a595d2016-08-17 21:11:01 +0200571 master->max_message_size = fsl_espi_max_message_size;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800572
573 mpc8xxx_spi = spi_master_get_devdata(master);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800574
Heiner Kallweit14238772016-09-07 22:50:22 +0200575 mpc8xxx_spi->local_buf =
576 devm_kmalloc(dev, SPCOM_TRANLEN_MAX, GFP_KERNEL);
577 if (!mpc8xxx_spi->local_buf) {
578 ret = -ENOMEM;
579 goto err_probe;
580 }
581
Heiner Kallweit4178b6b2015-08-26 21:21:50 +0200582 mpc8xxx_spi->reg_base = devm_ioremap_resource(dev, mem);
Axel Lin37c5db72015-08-30 18:35:51 +0800583 if (IS_ERR(mpc8xxx_spi->reg_base)) {
584 ret = PTR_ERR(mpc8xxx_spi->reg_base);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800585 goto err_probe;
586 }
587
588 reg_base = mpc8xxx_spi->reg_base;
589
590 /* Register for SPI Interrupt */
Heiner Kallweit4178b6b2015-08-26 21:21:50 +0200591 ret = devm_request_irq(dev, mpc8xxx_spi->irq, fsl_espi_irq,
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800592 0, "fsl_espi", mpc8xxx_spi);
593 if (ret)
Heiner Kallweit4178b6b2015-08-26 21:21:50 +0200594 goto err_probe;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800595
596 if (mpc8xxx_spi->flags & SPI_QE_CPU_MODE) {
597 mpc8xxx_spi->rx_shift = 16;
598 mpc8xxx_spi->tx_shift = 24;
599 }
600
601 /* SPI controller initializations */
602 mpc8xxx_spi_write_reg(&reg_base->mode, 0);
603 mpc8xxx_spi_write_reg(&reg_base->mask, 0);
604 mpc8xxx_spi_write_reg(&reg_base->command, 0);
605 mpc8xxx_spi_write_reg(&reg_base->event, 0xffffffff);
606
607 /* Init eSPI CS mode register */
Jane Wand0fb47a52014-04-16 13:09:39 -0700608 for_each_available_child_of_node(master->dev.of_node, nc) {
609 /* get chip select */
610 prop = of_get_property(nc, "reg", &len);
611 if (!prop || len < sizeof(*prop))
612 continue;
613 i = be32_to_cpup(prop);
614 if (i < 0 || i >= pdata->max_chipselect)
615 continue;
616
617 csmode = CSMODE_INIT_VAL;
618 /* check if CSBEF is set in device tree */
619 prop = of_get_property(nc, "fsl,csbef", &len);
620 if (prop && len >= sizeof(*prop)) {
621 csmode &= ~(CSMODE_BEF(0xf));
622 csmode |= CSMODE_BEF(be32_to_cpup(prop));
623 }
624 /* check if CSAFT is set in device tree */
625 prop = of_get_property(nc, "fsl,csaft", &len);
626 if (prop && len >= sizeof(*prop)) {
627 csmode &= ~(CSMODE_AFT(0xf));
628 csmode |= CSMODE_AFT(be32_to_cpup(prop));
629 }
630 mpc8xxx_spi_write_reg(&reg_base->csmode[i], csmode);
631
632 dev_info(dev, "cs=%d, init_csmode=0x%x\n", i, csmode);
633 }
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800634
635 /* Enable SPI interface */
636 regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
637
638 mpc8xxx_spi_write_reg(&reg_base->mode, regval);
639
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200640 pm_runtime_set_autosuspend_delay(dev, AUTOSUSPEND_TIMEOUT);
641 pm_runtime_use_autosuspend(dev);
642 pm_runtime_set_active(dev);
643 pm_runtime_enable(dev);
644 pm_runtime_get_sync(dev);
645
Heiner Kallweit4178b6b2015-08-26 21:21:50 +0200646 ret = devm_spi_register_master(dev, master);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800647 if (ret < 0)
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200648 goto err_pm;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800649
650 dev_info(dev, "at 0x%p (irq = %d)\n", reg_base, mpc8xxx_spi->irq);
651
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200652 pm_runtime_mark_last_busy(dev);
653 pm_runtime_put_autosuspend(dev);
654
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800655 return master;
656
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200657err_pm:
658 pm_runtime_put_noidle(dev);
659 pm_runtime_disable(dev);
660 pm_runtime_set_suspended(dev);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800661err_probe:
662 spi_master_put(master);
663err:
664 return ERR_PTR(ret);
665}
666
667static int of_fsl_espi_get_chipselects(struct device *dev)
668{
669 struct device_node *np = dev->of_node;
Jingoo Han8074cf02013-07-30 16:58:59 +0900670 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800671 const u32 *prop;
672 int len;
673
674 prop = of_get_property(np, "fsl,espi-num-chipselects", &len);
675 if (!prop || len < sizeof(*prop)) {
676 dev_err(dev, "No 'fsl,espi-num-chipselects' property\n");
677 return -EINVAL;
678 }
679
680 pdata->max_chipselect = *prop;
681 pdata->cs_control = NULL;
682
683 return 0;
684}
685
Grant Likelyfd4a3192012-12-07 16:57:14 +0000686static int of_fsl_espi_probe(struct platform_device *ofdev)
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800687{
688 struct device *dev = &ofdev->dev;
689 struct device_node *np = ofdev->dev.of_node;
690 struct spi_master *master;
691 struct resource mem;
Thierry Redingf7578492013-09-18 15:24:44 +0200692 unsigned int irq;
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800693 int ret = -ENOMEM;
694
Grant Likely18d306d2011-02-22 21:02:43 -0700695 ret = of_mpc8xxx_spi_probe(ofdev);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800696 if (ret)
697 return ret;
698
699 ret = of_fsl_espi_get_chipselects(dev);
700 if (ret)
701 goto err;
702
703 ret = of_address_to_resource(np, 0, &mem);
704 if (ret)
705 goto err;
706
Thierry Redingf7578492013-09-18 15:24:44 +0200707 irq = irq_of_parse_and_map(np, 0);
Hou Zhiqiang7227cd12013-12-11 13:09:40 +0800708 if (!irq) {
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800709 ret = -EINVAL;
710 goto err;
711 }
712
Thierry Redingf7578492013-09-18 15:24:44 +0200713 master = fsl_espi_probe(dev, &mem, irq);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800714 if (IS_ERR(master)) {
715 ret = PTR_ERR(master);
716 goto err;
717 }
718
719 return 0;
720
721err:
722 return ret;
723}
724
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200725static int of_fsl_espi_remove(struct platform_device *dev)
726{
727 pm_runtime_disable(&dev->dev);
728
729 return 0;
730}
731
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800732#ifdef CONFIG_PM_SLEEP
733static int of_fsl_espi_suspend(struct device *dev)
734{
735 struct spi_master *master = dev_get_drvdata(dev);
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800736 int ret;
737
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800738 ret = spi_master_suspend(master);
739 if (ret) {
740 dev_warn(dev, "cannot suspend master\n");
741 return ret;
742 }
743
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200744 ret = pm_runtime_force_suspend(dev);
745 if (ret < 0)
746 return ret;
747
748 return 0;
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800749}
750
751static int of_fsl_espi_resume(struct device *dev)
752{
753 struct fsl_spi_platform_data *pdata = dev_get_platdata(dev);
754 struct spi_master *master = dev_get_drvdata(dev);
755 struct mpc8xxx_spi *mpc8xxx_spi;
756 struct fsl_espi_reg *reg_base;
757 u32 regval;
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200758 int i, ret;
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800759
760 mpc8xxx_spi = spi_master_get_devdata(master);
761 reg_base = mpc8xxx_spi->reg_base;
762
763 /* SPI controller initializations */
764 mpc8xxx_spi_write_reg(&reg_base->mode, 0);
765 mpc8xxx_spi_write_reg(&reg_base->mask, 0);
766 mpc8xxx_spi_write_reg(&reg_base->command, 0);
767 mpc8xxx_spi_write_reg(&reg_base->event, 0xffffffff);
768
769 /* Init eSPI CS mode register */
770 for (i = 0; i < pdata->max_chipselect; i++)
771 mpc8xxx_spi_write_reg(&reg_base->csmode[i], CSMODE_INIT_VAL);
772
773 /* Enable SPI interface */
774 regval = pdata->initial_spmode | SPMODE_INIT_VAL | SPMODE_ENABLE;
775
776 mpc8xxx_spi_write_reg(&reg_base->mode, regval);
777
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200778 ret = pm_runtime_force_resume(dev);
779 if (ret < 0)
780 return ret;
781
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800782 return spi_master_resume(master);
783}
784#endif /* CONFIG_PM_SLEEP */
785
786static const struct dev_pm_ops espi_pm = {
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200787 SET_RUNTIME_PM_OPS(fsl_espi_runtime_suspend,
788 fsl_espi_runtime_resume, NULL)
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800789 SET_SYSTEM_SLEEP_PM_OPS(of_fsl_espi_suspend, of_fsl_espi_resume)
790};
791
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800792static const struct of_device_id of_fsl_espi_match[] = {
793 { .compatible = "fsl,mpc8536-espi" },
794 {}
795};
796MODULE_DEVICE_TABLE(of, of_fsl_espi_match);
797
Grant Likely18d306d2011-02-22 21:02:43 -0700798static struct platform_driver fsl_espi_driver = {
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800799 .driver = {
800 .name = "fsl_espi",
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800801 .of_match_table = of_fsl_espi_match,
Hou Zhiqiang714bb652013-12-12 12:53:52 +0800802 .pm = &espi_pm,
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800803 },
804 .probe = of_fsl_espi_probe,
Heiner Kallweite9abb4d2015-08-26 21:21:55 +0200805 .remove = of_fsl_espi_remove,
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800806};
Grant Likely940ab882011-10-05 11:29:49 -0600807module_platform_driver(fsl_espi_driver);
Mingkai Hu8b60d6c2010-10-12 18:18:32 +0800808
809MODULE_AUTHOR("Mingkai Hu");
810MODULE_DESCRIPTION("Enhanced Freescale SPI Driver");
811MODULE_LICENSE("GPL");