1 /* 2 * A driver for the ARM PL022 PrimeCell SSP/SPI bus master. 3 * 4 * Copyright (C) 2008-2012 ST-Ericsson AB 5 * Copyright (C) 2006 STMicroelectronics Pvt. Ltd. 6 * 7 * Author: Linus Walleij <linus.walleij@stericsson.com> 8 * 9 * Initial version inspired by: 10 * linux-2.6.17-rc3-mm1/drivers/spi/pxa2xx_spi.c 11 * Initial adoption to PL022 by: 12 * Sachin Verma <sachin.verma@st.com> 13 * 14 * This program is free software; you can redistribute it and/or modify 15 * it under the terms of the GNU General Public License as published by 16 * the Free Software Foundation; either version 2 of the License, or 17 * (at your option) any later version. 18 * 19 * This program is distributed in the hope that it will be useful, 20 * but WITHOUT ANY WARRANTY; without even the implied warranty of 21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 22 * GNU General Public License for more details. 23 */ 24 25 #include <linux/init.h> 26 #include <linux/module.h> 27 #include <linux/device.h> 28 #include <linux/ioport.h> 29 #include <linux/errno.h> 30 #include <linux/interrupt.h> 31 #include <linux/spi/spi.h> 32 #include <linux/delay.h> 33 #include <linux/clk.h> 34 #include <linux/err.h> 35 #include <linux/amba/bus.h> 36 #include <linux/amba/pl022.h> 37 #include <linux/io.h> 38 #include <linux/slab.h> 39 #include <linux/dmaengine.h> 40 #include <linux/dma-mapping.h> 41 #include <linux/scatterlist.h> 42 #include <linux/pm_runtime.h> 43 #include <linux/gpio.h> 44 #include <linux/of_gpio.h> 45 #include <linux/pinctrl/consumer.h> 46 47 /* 48 * This macro is used to define some register default values. 49 * reg is masked with mask, the OR:ed with an (again masked) 50 * val shifted sb steps to the left. 51 */ 52 #define SSP_WRITE_BITS(reg, val, mask, sb) \ 53 ((reg) = (((reg) & ~(mask)) | (((val)<<(sb)) & (mask)))) 54 55 /* 56 * This macro is also used to define some default values. 57 * It will just shift val by sb steps to the left and mask 58 * the result with mask. 59 */ 60 #define GEN_MASK_BITS(val, mask, sb) \ 61 (((val)<<(sb)) & (mask)) 62 63 #define DRIVE_TX 0 64 #define DO_NOT_DRIVE_TX 1 65 66 #define DO_NOT_QUEUE_DMA 0 67 #define QUEUE_DMA 1 68 69 #define RX_TRANSFER 1 70 #define TX_TRANSFER 2 71 72 /* 73 * Macros to access SSP Registers with their offsets 74 */ 75 #define SSP_CR0(r) (r + 0x000) 76 #define SSP_CR1(r) (r + 0x004) 77 #define SSP_DR(r) (r + 0x008) 78 #define SSP_SR(r) (r + 0x00C) 79 #define SSP_CPSR(r) (r + 0x010) 80 #define SSP_IMSC(r) (r + 0x014) 81 #define SSP_RIS(r) (r + 0x018) 82 #define SSP_MIS(r) (r + 0x01C) 83 #define SSP_ICR(r) (r + 0x020) 84 #define SSP_DMACR(r) (r + 0x024) 85 #define SSP_ITCR(r) (r + 0x080) 86 #define SSP_ITIP(r) (r + 0x084) 87 #define SSP_ITOP(r) (r + 0x088) 88 #define SSP_TDR(r) (r + 0x08C) 89 90 #define SSP_PID0(r) (r + 0xFE0) 91 #define SSP_PID1(r) (r + 0xFE4) 92 #define SSP_PID2(r) (r + 0xFE8) 93 #define SSP_PID3(r) (r + 0xFEC) 94 95 #define SSP_CID0(r) (r + 0xFF0) 96 #define SSP_CID1(r) (r + 0xFF4) 97 #define SSP_CID2(r) (r + 0xFF8) 98 #define SSP_CID3(r) (r + 0xFFC) 99 100 /* 101 * SSP Control Register 0 - SSP_CR0 102 */ 103 #define SSP_CR0_MASK_DSS (0x0FUL << 0) 104 #define SSP_CR0_MASK_FRF (0x3UL << 4) 105 #define SSP_CR0_MASK_SPO (0x1UL << 6) 106 #define SSP_CR0_MASK_SPH (0x1UL << 7) 107 #define SSP_CR0_MASK_SCR (0xFFUL << 8) 108 109 /* 110 * The ST version of this block moves som bits 111 * in SSP_CR0 and extends it to 32 bits 112 */ 113 #define SSP_CR0_MASK_DSS_ST (0x1FUL << 0) 114 #define SSP_CR0_MASK_HALFDUP_ST (0x1UL << 5) 115 #define SSP_CR0_MASK_CSS_ST (0x1FUL << 16) 116 #define SSP_CR0_MASK_FRF_ST (0x3UL << 21) 117 118 /* 119 * SSP Control Register 0 - SSP_CR1 120 */ 121 #define SSP_CR1_MASK_LBM (0x1UL << 0) 122 #define SSP_CR1_MASK_SSE (0x1UL << 1) 123 #define SSP_CR1_MASK_MS (0x1UL << 2) 124 #define SSP_CR1_MASK_SOD (0x1UL << 3) 125 126 /* 127 * The ST version of this block adds some bits 128 * in SSP_CR1 129 */ 130 #define SSP_CR1_MASK_RENDN_ST (0x1UL << 4) 131 #define SSP_CR1_MASK_TENDN_ST (0x1UL << 5) 132 #define SSP_CR1_MASK_MWAIT_ST (0x1UL << 6) 133 #define SSP_CR1_MASK_RXIFLSEL_ST (0x7UL << 7) 134 #define SSP_CR1_MASK_TXIFLSEL_ST (0x7UL << 10) 135 /* This one is only in the PL023 variant */ 136 #define SSP_CR1_MASK_FBCLKDEL_ST (0x7UL << 13) 137 138 /* 139 * SSP Status Register - SSP_SR 140 */ 141 #define SSP_SR_MASK_TFE (0x1UL << 0) /* Transmit FIFO empty */ 142 #define SSP_SR_MASK_TNF (0x1UL << 1) /* Transmit FIFO not full */ 143 #define SSP_SR_MASK_RNE (0x1UL << 2) /* Receive FIFO not empty */ 144 #define SSP_SR_MASK_RFF (0x1UL << 3) /* Receive FIFO full */ 145 #define SSP_SR_MASK_BSY (0x1UL << 4) /* Busy Flag */ 146 147 /* 148 * SSP Clock Prescale Register - SSP_CPSR 149 */ 150 #define SSP_CPSR_MASK_CPSDVSR (0xFFUL << 0) 151 152 /* 153 * SSP Interrupt Mask Set/Clear Register - SSP_IMSC 154 */ 155 #define SSP_IMSC_MASK_RORIM (0x1UL << 0) /* Receive Overrun Interrupt mask */ 156 #define SSP_IMSC_MASK_RTIM (0x1UL << 1) /* Receive timeout Interrupt mask */ 157 #define SSP_IMSC_MASK_RXIM (0x1UL << 2) /* Receive FIFO Interrupt mask */ 158 #define SSP_IMSC_MASK_TXIM (0x1UL << 3) /* Transmit FIFO Interrupt mask */ 159 160 /* 161 * SSP Raw Interrupt Status Register - SSP_RIS 162 */ 163 /* Receive Overrun Raw Interrupt status */ 164 #define SSP_RIS_MASK_RORRIS (0x1UL << 0) 165 /* Receive Timeout Raw Interrupt status */ 166 #define SSP_RIS_MASK_RTRIS (0x1UL << 1) 167 /* Receive FIFO Raw Interrupt status */ 168 #define SSP_RIS_MASK_RXRIS (0x1UL << 2) 169 /* Transmit FIFO Raw Interrupt status */ 170 #define SSP_RIS_MASK_TXRIS (0x1UL << 3) 171 172 /* 173 * SSP Masked Interrupt Status Register - SSP_MIS 174 */ 175 /* Receive Overrun Masked Interrupt status */ 176 #define SSP_MIS_MASK_RORMIS (0x1UL << 0) 177 /* Receive Timeout Masked Interrupt status */ 178 #define SSP_MIS_MASK_RTMIS (0x1UL << 1) 179 /* Receive FIFO Masked Interrupt status */ 180 #define SSP_MIS_MASK_RXMIS (0x1UL << 2) 181 /* Transmit FIFO Masked Interrupt status */ 182 #define SSP_MIS_MASK_TXMIS (0x1UL << 3) 183 184 /* 185 * SSP Interrupt Clear Register - SSP_ICR 186 */ 187 /* Receive Overrun Raw Clear Interrupt bit */ 188 #define SSP_ICR_MASK_RORIC (0x1UL << 0) 189 /* Receive Timeout Clear Interrupt bit */ 190 #define SSP_ICR_MASK_RTIC (0x1UL << 1) 191 192 /* 193 * SSP DMA Control Register - SSP_DMACR 194 */ 195 /* Receive DMA Enable bit */ 196 #define SSP_DMACR_MASK_RXDMAE (0x1UL << 0) 197 /* Transmit DMA Enable bit */ 198 #define SSP_DMACR_MASK_TXDMAE (0x1UL << 1) 199 200 /* 201 * SSP Integration Test control Register - SSP_ITCR 202 */ 203 #define SSP_ITCR_MASK_ITEN (0x1UL << 0) 204 #define SSP_ITCR_MASK_TESTFIFO (0x1UL << 1) 205 206 /* 207 * SSP Integration Test Input Register - SSP_ITIP 208 */ 209 #define ITIP_MASK_SSPRXD (0x1UL << 0) 210 #define ITIP_MASK_SSPFSSIN (0x1UL << 1) 211 #define ITIP_MASK_SSPCLKIN (0x1UL << 2) 212 #define ITIP_MASK_RXDMAC (0x1UL << 3) 213 #define ITIP_MASK_TXDMAC (0x1UL << 4) 214 #define ITIP_MASK_SSPTXDIN (0x1UL << 5) 215 216 /* 217 * SSP Integration Test output Register - SSP_ITOP 218 */ 219 #define ITOP_MASK_SSPTXD (0x1UL << 0) 220 #define ITOP_MASK_SSPFSSOUT (0x1UL << 1) 221 #define ITOP_MASK_SSPCLKOUT (0x1UL << 2) 222 #define ITOP_MASK_SSPOEn (0x1UL << 3) 223 #define ITOP_MASK_SSPCTLOEn (0x1UL << 4) 224 #define ITOP_MASK_RORINTR (0x1UL << 5) 225 #define ITOP_MASK_RTINTR (0x1UL << 6) 226 #define ITOP_MASK_RXINTR (0x1UL << 7) 227 #define ITOP_MASK_TXINTR (0x1UL << 8) 228 #define ITOP_MASK_INTR (0x1UL << 9) 229 #define ITOP_MASK_RXDMABREQ (0x1UL << 10) 230 #define ITOP_MASK_RXDMASREQ (0x1UL << 11) 231 #define ITOP_MASK_TXDMABREQ (0x1UL << 12) 232 #define ITOP_MASK_TXDMASREQ (0x1UL << 13) 233 234 /* 235 * SSP Test Data Register - SSP_TDR 236 */ 237 #define TDR_MASK_TESTDATA (0xFFFFFFFF) 238 239 /* 240 * Message State 241 * we use the spi_message.state (void *) pointer to 242 * hold a single state value, that's why all this 243 * (void *) casting is done here. 244 */ 245 #define STATE_START ((void *) 0) 246 #define STATE_RUNNING ((void *) 1) 247 #define STATE_DONE ((void *) 2) 248 #define STATE_ERROR ((void *) -1) 249 250 /* 251 * SSP State - Whether Enabled or Disabled 252 */ 253 #define SSP_DISABLED (0) 254 #define SSP_ENABLED (1) 255 256 /* 257 * SSP DMA State - Whether DMA Enabled or Disabled 258 */ 259 #define SSP_DMA_DISABLED (0) 260 #define SSP_DMA_ENABLED (1) 261 262 /* 263 * SSP Clock Defaults 264 */ 265 #define SSP_DEFAULT_CLKRATE 0x2 266 #define SSP_DEFAULT_PRESCALE 0x40 267 268 /* 269 * SSP Clock Parameter ranges 270 */ 271 #define CPSDVR_MIN 0x02 272 #define CPSDVR_MAX 0xFE 273 #define SCR_MIN 0x00 274 #define SCR_MAX 0xFF 275 276 /* 277 * SSP Interrupt related Macros 278 */ 279 #define DEFAULT_SSP_REG_IMSC 0x0UL 280 #define DISABLE_ALL_INTERRUPTS DEFAULT_SSP_REG_IMSC 281 #define ENABLE_ALL_INTERRUPTS (~DEFAULT_SSP_REG_IMSC) 282 283 #define CLEAR_ALL_INTERRUPTS 0x3 284 285 #define SPI_POLLING_TIMEOUT 1000 286 287 /* 288 * The type of reading going on on this chip 289 */ 290 enum ssp_reading { 291 READING_NULL, 292 READING_U8, 293 READING_U16, 294 READING_U32 295 }; 296 297 /** 298 * The type of writing going on on this chip 299 */ 300 enum ssp_writing { 301 WRITING_NULL, 302 WRITING_U8, 303 WRITING_U16, 304 WRITING_U32 305 }; 306 307 /** 308 * struct vendor_data - vendor-specific config parameters 309 * for PL022 derivates 310 * @fifodepth: depth of FIFOs (both) 311 * @max_bpw: maximum number of bits per word 312 * @unidir: supports unidirection transfers 313 * @extended_cr: 32 bit wide control register 0 with extra 314 * features and extra features in CR1 as found in the ST variants 315 * @pl023: supports a subset of the ST extensions called "PL023" 316 */ 317 struct vendor_data { 318 int fifodepth; 319 int max_bpw; 320 bool unidir; 321 bool extended_cr; 322 bool pl023; 323 bool loopback; 324 }; 325 326 /** 327 * struct pl022 - This is the private SSP driver data structure 328 * @adev: AMBA device model hookup 329 * @vendor: vendor data for the IP block 330 * @phybase: the physical memory where the SSP device resides 331 * @virtbase: the virtual memory where the SSP is mapped 332 * @clk: outgoing clock "SPICLK" for the SPI bus 333 * @master: SPI framework hookup 334 * @master_info: controller-specific data from machine setup 335 * @kworker: thread struct for message pump 336 * @kworker_task: pointer to task for message pump kworker thread 337 * @pump_messages: work struct for scheduling work to the message pump 338 * @queue_lock: spinlock to syncronise access to message queue 339 * @queue: message queue 340 * @busy: message pump is busy 341 * @running: message pump is running 342 * @pump_transfers: Tasklet used in Interrupt Transfer mode 343 * @cur_msg: Pointer to current spi_message being processed 344 * @cur_transfer: Pointer to current spi_transfer 345 * @cur_chip: pointer to current clients chip(assigned from controller_state) 346 * @next_msg_cs_active: the next message in the queue has been examined 347 * and it was found that it uses the same chip select as the previous 348 * message, so we left it active after the previous transfer, and it's 349 * active already. 350 * @tx: current position in TX buffer to be read 351 * @tx_end: end position in TX buffer to be read 352 * @rx: current position in RX buffer to be written 353 * @rx_end: end position in RX buffer to be written 354 * @read: the type of read currently going on 355 * @write: the type of write currently going on 356 * @exp_fifo_level: expected FIFO level 357 * @dma_rx_channel: optional channel for RX DMA 358 * @dma_tx_channel: optional channel for TX DMA 359 * @sgt_rx: scattertable for the RX transfer 360 * @sgt_tx: scattertable for the TX transfer 361 * @dummypage: a dummy page used for driving data on the bus with DMA 362 * @cur_cs: current chip select (gpio) 363 * @chipselects: list of chipselects (gpios) 364 */ 365 struct pl022 { 366 struct amba_device *adev; 367 struct vendor_data *vendor; 368 resource_size_t phybase; 369 void __iomem *virtbase; 370 struct clk *clk; 371 /* Two optional pin states - default & sleep */ 372 struct pinctrl *pinctrl; 373 struct pinctrl_state *pins_default; 374 struct pinctrl_state *pins_idle; 375 struct pinctrl_state *pins_sleep; 376 struct spi_master *master; 377 struct pl022_ssp_controller *master_info; 378 /* Message per-transfer pump */ 379 struct tasklet_struct pump_transfers; 380 struct spi_message *cur_msg; 381 struct spi_transfer *cur_transfer; 382 struct chip_data *cur_chip; 383 bool next_msg_cs_active; 384 void *tx; 385 void *tx_end; 386 void *rx; 387 void *rx_end; 388 enum ssp_reading read; 389 enum ssp_writing write; 390 u32 exp_fifo_level; 391 enum ssp_rx_level_trig rx_lev_trig; 392 enum ssp_tx_level_trig tx_lev_trig; 393 /* DMA settings */ 394 #ifdef CONFIG_DMA_ENGINE 395 struct dma_chan *dma_rx_channel; 396 struct dma_chan *dma_tx_channel; 397 struct sg_table sgt_rx; 398 struct sg_table sgt_tx; 399 char *dummypage; 400 bool dma_running; 401 #endif 402 int cur_cs; 403 int *chipselects; 404 }; 405 406 /** 407 * struct chip_data - To maintain runtime state of SSP for each client chip 408 * @cr0: Value of control register CR0 of SSP - on later ST variants this 409 * register is 32 bits wide rather than just 16 410 * @cr1: Value of control register CR1 of SSP 411 * @dmacr: Value of DMA control Register of SSP 412 * @cpsr: Value of Clock prescale register 413 * @n_bytes: how many bytes(power of 2) reqd for a given data width of client 414 * @enable_dma: Whether to enable DMA or not 415 * @read: function ptr to be used to read when doing xfer for this chip 416 * @write: function ptr to be used to write when doing xfer for this chip 417 * @cs_control: chip select callback provided by chip 418 * @xfer_type: polling/interrupt/DMA 419 * 420 * Runtime state of the SSP controller, maintained per chip, 421 * This would be set according to the current message that would be served 422 */ 423 struct chip_data { 424 u32 cr0; 425 u16 cr1; 426 u16 dmacr; 427 u16 cpsr; 428 u8 n_bytes; 429 bool enable_dma; 430 enum ssp_reading read; 431 enum ssp_writing write; 432 void (*cs_control) (u32 command); 433 int xfer_type; 434 }; 435 436 /** 437 * null_cs_control - Dummy chip select function 438 * @command: select/delect the chip 439 * 440 * If no chip select function is provided by client this is used as dummy 441 * chip select 442 */ 443 static void null_cs_control(u32 command) 444 { 445 pr_debug("pl022: dummy chip select control, CS=0x%x\n", command); 446 } 447 448 static void pl022_cs_control(struct pl022 *pl022, u32 command) 449 { 450 if (gpio_is_valid(pl022->cur_cs)) 451 gpio_set_value(pl022->cur_cs, command); 452 else 453 pl022->cur_chip->cs_control(command); 454 } 455 456 /** 457 * giveback - current spi_message is over, schedule next message and call 458 * callback of this message. Assumes that caller already 459 * set message->status; dma and pio irqs are blocked 460 * @pl022: SSP driver private data structure 461 */ 462 static void giveback(struct pl022 *pl022) 463 { 464 struct spi_transfer *last_transfer; 465 pl022->next_msg_cs_active = false; 466 467 last_transfer = list_entry(pl022->cur_msg->transfers.prev, 468 struct spi_transfer, 469 transfer_list); 470 471 /* Delay if requested before any change in chip select */ 472 if (last_transfer->delay_usecs) 473 /* 474 * FIXME: This runs in interrupt context. 475 * Is this really smart? 476 */ 477 udelay(last_transfer->delay_usecs); 478 479 if (!last_transfer->cs_change) { 480 struct spi_message *next_msg; 481 482 /* 483 * cs_change was not set. We can keep the chip select 484 * enabled if there is message in the queue and it is 485 * for the same spi device. 486 * 487 * We cannot postpone this until pump_messages, because 488 * after calling msg->complete (below) the driver that 489 * sent the current message could be unloaded, which 490 * could invalidate the cs_control() callback... 491 */ 492 /* get a pointer to the next message, if any */ 493 next_msg = spi_get_next_queued_message(pl022->master); 494 495 /* 496 * see if the next and current messages point 497 * to the same spi device. 498 */ 499 if (next_msg && next_msg->spi != pl022->cur_msg->spi) 500 next_msg = NULL; 501 if (!next_msg || pl022->cur_msg->state == STATE_ERROR) 502 pl022_cs_control(pl022, SSP_CHIP_DESELECT); 503 else 504 pl022->next_msg_cs_active = true; 505 506 } 507 508 pl022->cur_msg = NULL; 509 pl022->cur_transfer = NULL; 510 pl022->cur_chip = NULL; 511 spi_finalize_current_message(pl022->master); 512 513 /* disable the SPI/SSP operation */ 514 writew((readw(SSP_CR1(pl022->virtbase)) & 515 (~SSP_CR1_MASK_SSE)), SSP_CR1(pl022->virtbase)); 516 517 } 518 519 /** 520 * flush - flush the FIFO to reach a clean state 521 * @pl022: SSP driver private data structure 522 */ 523 static int flush(struct pl022 *pl022) 524 { 525 unsigned long limit = loops_per_jiffy << 1; 526 527 dev_dbg(&pl022->adev->dev, "flush\n"); 528 do { 529 while (readw(SSP_SR(pl022->virtbase)) & SSP_SR_MASK_RNE) 530 readw(SSP_DR(pl022->virtbase)); 531 } while ((readw(SSP_SR(pl022->virtbase)) & SSP_SR_MASK_BSY) && limit--); 532 533 pl022->exp_fifo_level = 0; 534 535 return limit; 536 } 537 538 /** 539 * restore_state - Load configuration of current chip 540 * @pl022: SSP driver private data structure 541 */ 542 static void restore_state(struct pl022 *pl022) 543 { 544 struct chip_data *chip = pl022->cur_chip; 545 546 if (pl022->vendor->extended_cr) 547 writel(chip->cr0, SSP_CR0(pl022->virtbase)); 548 else 549 writew(chip->cr0, SSP_CR0(pl022->virtbase)); 550 writew(chip->cr1, SSP_CR1(pl022->virtbase)); 551 writew(chip->dmacr, SSP_DMACR(pl022->virtbase)); 552 writew(chip->cpsr, SSP_CPSR(pl022->virtbase)); 553 writew(DISABLE_ALL_INTERRUPTS, SSP_IMSC(pl022->virtbase)); 554 writew(CLEAR_ALL_INTERRUPTS, SSP_ICR(pl022->virtbase)); 555 } 556 557 /* 558 * Default SSP Register Values 559 */ 560 #define DEFAULT_SSP_REG_CR0 ( \ 561 GEN_MASK_BITS(SSP_DATA_BITS_12, SSP_CR0_MASK_DSS, 0) | \ 562 GEN_MASK_BITS(SSP_INTERFACE_MOTOROLA_SPI, SSP_CR0_MASK_FRF, 4) | \ 563 GEN_MASK_BITS(SSP_CLK_POL_IDLE_LOW, SSP_CR0_MASK_SPO, 6) | \ 564 GEN_MASK_BITS(SSP_CLK_SECOND_EDGE, SSP_CR0_MASK_SPH, 7) | \ 565 GEN_MASK_BITS(SSP_DEFAULT_CLKRATE, SSP_CR0_MASK_SCR, 8) \ 566 ) 567 568 /* ST versions have slightly different bit layout */ 569 #define DEFAULT_SSP_REG_CR0_ST ( \ 570 GEN_MASK_BITS(SSP_DATA_BITS_12, SSP_CR0_MASK_DSS_ST, 0) | \ 571 GEN_MASK_BITS(SSP_MICROWIRE_CHANNEL_FULL_DUPLEX, SSP_CR0_MASK_HALFDUP_ST, 5) | \ 572 GEN_MASK_BITS(SSP_CLK_POL_IDLE_LOW, SSP_CR0_MASK_SPO, 6) | \ 573 GEN_MASK_BITS(SSP_CLK_SECOND_EDGE, SSP_CR0_MASK_SPH, 7) | \ 574 GEN_MASK_BITS(SSP_DEFAULT_CLKRATE, SSP_CR0_MASK_SCR, 8) | \ 575 GEN_MASK_BITS(SSP_BITS_8, SSP_CR0_MASK_CSS_ST, 16) | \ 576 GEN_MASK_BITS(SSP_INTERFACE_MOTOROLA_SPI, SSP_CR0_MASK_FRF_ST, 21) \ 577 ) 578 579 /* The PL023 version is slightly different again */ 580 #define DEFAULT_SSP_REG_CR0_ST_PL023 ( \ 581 GEN_MASK_BITS(SSP_DATA_BITS_12, SSP_CR0_MASK_DSS_ST, 0) | \ 582 GEN_MASK_BITS(SSP_CLK_POL_IDLE_LOW, SSP_CR0_MASK_SPO, 6) | \ 583 GEN_MASK_BITS(SSP_CLK_SECOND_EDGE, SSP_CR0_MASK_SPH, 7) | \ 584 GEN_MASK_BITS(SSP_DEFAULT_CLKRATE, SSP_CR0_MASK_SCR, 8) \ 585 ) 586 587 #define DEFAULT_SSP_REG_CR1 ( \ 588 GEN_MASK_BITS(LOOPBACK_DISABLED, SSP_CR1_MASK_LBM, 0) | \ 589 GEN_MASK_BITS(SSP_DISABLED, SSP_CR1_MASK_SSE, 1) | \ 590 GEN_MASK_BITS(SSP_MASTER, SSP_CR1_MASK_MS, 2) | \ 591 GEN_MASK_BITS(DO_NOT_DRIVE_TX, SSP_CR1_MASK_SOD, 3) \ 592 ) 593 594 /* ST versions extend this register to use all 16 bits */ 595 #define DEFAULT_SSP_REG_CR1_ST ( \ 596 DEFAULT_SSP_REG_CR1 | \ 597 GEN_MASK_BITS(SSP_RX_MSB, SSP_CR1_MASK_RENDN_ST, 4) | \ 598 GEN_MASK_BITS(SSP_TX_MSB, SSP_CR1_MASK_TENDN_ST, 5) | \ 599 GEN_MASK_BITS(SSP_MWIRE_WAIT_ZERO, SSP_CR1_MASK_MWAIT_ST, 6) |\ 600 GEN_MASK_BITS(SSP_RX_1_OR_MORE_ELEM, SSP_CR1_MASK_RXIFLSEL_ST, 7) | \ 601 GEN_MASK_BITS(SSP_TX_1_OR_MORE_EMPTY_LOC, SSP_CR1_MASK_TXIFLSEL_ST, 10) \ 602 ) 603 604 /* 605 * The PL023 variant has further differences: no loopback mode, no microwire 606 * support, and a new clock feedback delay setting. 607 */ 608 #define DEFAULT_SSP_REG_CR1_ST_PL023 ( \ 609 GEN_MASK_BITS(SSP_DISABLED, SSP_CR1_MASK_SSE, 1) | \ 610 GEN_MASK_BITS(SSP_MASTER, SSP_CR1_MASK_MS, 2) | \ 611 GEN_MASK_BITS(DO_NOT_DRIVE_TX, SSP_CR1_MASK_SOD, 3) | \ 612 GEN_MASK_BITS(SSP_RX_MSB, SSP_CR1_MASK_RENDN_ST, 4) | \ 613 GEN_MASK_BITS(SSP_TX_MSB, SSP_CR1_MASK_TENDN_ST, 5) | \ 614 GEN_MASK_BITS(SSP_RX_1_OR_MORE_ELEM, SSP_CR1_MASK_RXIFLSEL_ST, 7) | \ 615 GEN_MASK_BITS(SSP_TX_1_OR_MORE_EMPTY_LOC, SSP_CR1_MASK_TXIFLSEL_ST, 10) | \ 616 GEN_MASK_BITS(SSP_FEEDBACK_CLK_DELAY_NONE, SSP_CR1_MASK_FBCLKDEL_ST, 13) \ 617 ) 618 619 #define DEFAULT_SSP_REG_CPSR ( \ 620 GEN_MASK_BITS(SSP_DEFAULT_PRESCALE, SSP_CPSR_MASK_CPSDVSR, 0) \ 621 ) 622 623 #define DEFAULT_SSP_REG_DMACR (\ 624 GEN_MASK_BITS(SSP_DMA_DISABLED, SSP_DMACR_MASK_RXDMAE, 0) | \ 625 GEN_MASK_BITS(SSP_DMA_DISABLED, SSP_DMACR_MASK_TXDMAE, 1) \ 626 ) 627 628 /** 629 * load_ssp_default_config - Load default configuration for SSP 630 * @pl022: SSP driver private data structure 631 */ 632 static void load_ssp_default_config(struct pl022 *pl022) 633 { 634 if (pl022->vendor->pl023) { 635 writel(DEFAULT_SSP_REG_CR0_ST_PL023, SSP_CR0(pl022->virtbase)); 636 writew(DEFAULT_SSP_REG_CR1_ST_PL023, SSP_CR1(pl022->virtbase)); 637 } else if (pl022->vendor->extended_cr) { 638 writel(DEFAULT_SSP_REG_CR0_ST, SSP_CR0(pl022->virtbase)); 639 writew(DEFAULT_SSP_REG_CR1_ST, SSP_CR1(pl022->virtbase)); 640 } else { 641 writew(DEFAULT_SSP_REG_CR0, SSP_CR0(pl022->virtbase)); 642 writew(DEFAULT_SSP_REG_CR1, SSP_CR1(pl022->virtbase)); 643 } 644 writew(DEFAULT_SSP_REG_DMACR, SSP_DMACR(pl022->virtbase)); 645 writew(DEFAULT_SSP_REG_CPSR, SSP_CPSR(pl022->virtbase)); 646 writew(DISABLE_ALL_INTERRUPTS, SSP_IMSC(pl022->virtbase)); 647 writew(CLEAR_ALL_INTERRUPTS, SSP_ICR(pl022->virtbase)); 648 } 649 650 /** 651 * This will write to TX and read from RX according to the parameters 652 * set in pl022. 653 */ 654 static void readwriter(struct pl022 *pl022) 655 { 656 657 /* 658 * The FIFO depth is different between primecell variants. 659 * I believe filling in too much in the FIFO might cause 660 * errons in 8bit wide transfers on ARM variants (just 8 words 661 * FIFO, means only 8x8 = 64 bits in FIFO) at least. 662 * 663 * To prevent this issue, the TX FIFO is only filled to the 664 * unused RX FIFO fill length, regardless of what the TX 665 * FIFO status flag indicates. 666 */ 667 dev_dbg(&pl022->adev->dev, 668 "%s, rx: %p, rxend: %p, tx: %p, txend: %p\n", 669 __func__, pl022->rx, pl022->rx_end, pl022->tx, pl022->tx_end); 670 671 /* Read as much as you can */ 672 while ((readw(SSP_SR(pl022->virtbase)) & SSP_SR_MASK_RNE) 673 && (pl022->rx < pl022->rx_end)) { 674 switch (pl022->read) { 675 case READING_NULL: 676 readw(SSP_DR(pl022->virtbase)); 677 break; 678 case READING_U8: 679 *(u8 *) (pl022->rx) = 680 readw(SSP_DR(pl022->virtbase)) & 0xFFU; 681 break; 682 case READING_U16: 683 *(u16 *) (pl022->rx) = 684 (u16) readw(SSP_DR(pl022->virtbase)); 685 break; 686 case READING_U32: 687 *(u32 *) (pl022->rx) = 688 readl(SSP_DR(pl022->virtbase)); 689 break; 690 } 691 pl022->rx += (pl022->cur_chip->n_bytes); 692 pl022->exp_fifo_level--; 693 } 694 /* 695 * Write as much as possible up to the RX FIFO size 696 */ 697 while ((pl022->exp_fifo_level < pl022->vendor->fifodepth) 698 && (pl022->tx < pl022->tx_end)) { 699 switch (pl022->write) { 700 case WRITING_NULL: 701 writew(0x0, SSP_DR(pl022->virtbase)); 702 break; 703 case WRITING_U8: 704 writew(*(u8 *) (pl022->tx), SSP_DR(pl022->virtbase)); 705 break; 706 case WRITING_U16: 707 writew((*(u16 *) (pl022->tx)), SSP_DR(pl022->virtbase)); 708 break; 709 case WRITING_U32: 710 writel(*(u32 *) (pl022->tx), SSP_DR(pl022->virtbase)); 711 break; 712 } 713 pl022->tx += (pl022->cur_chip->n_bytes); 714 pl022->exp_fifo_level++; 715 /* 716 * This inner reader takes care of things appearing in the RX 717 * FIFO as we're transmitting. This will happen a lot since the 718 * clock starts running when you put things into the TX FIFO, 719 * and then things are continuously clocked into the RX FIFO. 720 */ 721 while ((readw(SSP_SR(pl022->virtbase)) & SSP_SR_MASK_RNE) 722 && (pl022->rx < pl022->rx_end)) { 723 switch (pl022->read) { 724 case READING_NULL: 725 readw(SSP_DR(pl022->virtbase)); 726 break; 727 case READING_U8: 728 *(u8 *) (pl022->rx) = 729 readw(SSP_DR(pl022->virtbase)) & 0xFFU; 730 break; 731 case READING_U16: 732 *(u16 *) (pl022->rx) = 733 (u16) readw(SSP_DR(pl022->virtbase)); 734 break; 735 case READING_U32: 736 *(u32 *) (pl022->rx) = 737 readl(SSP_DR(pl022->virtbase)); 738 break; 739 } 740 pl022->rx += (pl022->cur_chip->n_bytes); 741 pl022->exp_fifo_level--; 742 } 743 } 744 /* 745 * When we exit here the TX FIFO should be full and the RX FIFO 746 * should be empty 747 */ 748 } 749 750 /** 751 * next_transfer - Move to the Next transfer in the current spi message 752 * @pl022: SSP driver private data structure 753 * 754 * This function moves though the linked list of spi transfers in the 755 * current spi message and returns with the state of current spi 756 * message i.e whether its last transfer is done(STATE_DONE) or 757 * Next transfer is ready(STATE_RUNNING) 758 */ 759 static void *next_transfer(struct pl022 *pl022) 760 { 761 struct spi_message *msg = pl022->cur_msg; 762 struct spi_transfer *trans = pl022->cur_transfer; 763 764 /* Move to next transfer */ 765 if (trans->transfer_list.next != &msg->transfers) { 766 pl022->cur_transfer = 767 list_entry(trans->transfer_list.next, 768 struct spi_transfer, transfer_list); 769 return STATE_RUNNING; 770 } 771 return STATE_DONE; 772 } 773 774 /* 775 * This DMA functionality is only compiled in if we have 776 * access to the generic DMA devices/DMA engine. 777 */ 778 #ifdef CONFIG_DMA_ENGINE 779 static void unmap_free_dma_scatter(struct pl022 *pl022) 780 { 781 /* Unmap and free the SG tables */ 782 dma_unmap_sg(pl022->dma_tx_channel->device->dev, pl022->sgt_tx.sgl, 783 pl022->sgt_tx.nents, DMA_TO_DEVICE); 784 dma_unmap_sg(pl022->dma_rx_channel->device->dev, pl022->sgt_rx.sgl, 785 pl022->sgt_rx.nents, DMA_FROM_DEVICE); 786 sg_free_table(&pl022->sgt_rx); 787 sg_free_table(&pl022->sgt_tx); 788 } 789 790 static void dma_callback(void *data) 791 { 792 struct pl022 *pl022 = data; 793 struct spi_message *msg = pl022->cur_msg; 794 795 BUG_ON(!pl022->sgt_rx.sgl); 796 797 #ifdef VERBOSE_DEBUG 798 /* 799 * Optionally dump out buffers to inspect contents, this is 800 * good if you want to convince yourself that the loopback 801 * read/write contents are the same, when adopting to a new 802 * DMA engine. 803 */ 804 { 805 struct scatterlist *sg; 806 unsigned int i; 807 808 dma_sync_sg_for_cpu(&pl022->adev->dev, 809 pl022->sgt_rx.sgl, 810 pl022->sgt_rx.nents, 811 DMA_FROM_DEVICE); 812 813 for_each_sg(pl022->sgt_rx.sgl, sg, pl022->sgt_rx.nents, i) { 814 dev_dbg(&pl022->adev->dev, "SPI RX SG ENTRY: %d", i); 815 print_hex_dump(KERN_ERR, "SPI RX: ", 816 DUMP_PREFIX_OFFSET, 817 16, 818 1, 819 sg_virt(sg), 820 sg_dma_len(sg), 821 1); 822 } 823 for_each_sg(pl022->sgt_tx.sgl, sg, pl022->sgt_tx.nents, i) { 824 dev_dbg(&pl022->adev->dev, "SPI TX SG ENTRY: %d", i); 825 print_hex_dump(KERN_ERR, "SPI TX: ", 826 DUMP_PREFIX_OFFSET, 827 16, 828 1, 829 sg_virt(sg), 830 sg_dma_len(sg), 831 1); 832 } 833 } 834 #endif 835 836 unmap_free_dma_scatter(pl022); 837 838 /* Update total bytes transferred */ 839 msg->actual_length += pl022->cur_transfer->len; 840 if (pl022->cur_transfer->cs_change) 841 pl022_cs_control(pl022, SSP_CHIP_DESELECT); 842 843 /* Move to next transfer */ 844 msg->state = next_transfer(pl022); 845 tasklet_schedule(&pl022->pump_transfers); 846 } 847 848 static void setup_dma_scatter(struct pl022 *pl022, 849 void *buffer, 850 unsigned int length, 851 struct sg_table *sgtab) 852 { 853 struct scatterlist *sg; 854 int bytesleft = length; 855 void *bufp = buffer; 856 int mapbytes; 857 int i; 858 859 if (buffer) { 860 for_each_sg(sgtab->sgl, sg, sgtab->nents, i) { 861 /* 862 * If there are less bytes left than what fits 863 * in the current page (plus page alignment offset) 864 * we just feed in this, else we stuff in as much 865 * as we can. 866 */ 867 if (bytesleft < (PAGE_SIZE - offset_in_page(bufp))) 868 mapbytes = bytesleft; 869 else 870 mapbytes = PAGE_SIZE - offset_in_page(bufp); 871 sg_set_page(sg, virt_to_page(bufp), 872 mapbytes, offset_in_page(bufp)); 873 bufp += mapbytes; 874 bytesleft -= mapbytes; 875 dev_dbg(&pl022->adev->dev, 876 "set RX/TX target page @ %p, %d bytes, %d left\n", 877 bufp, mapbytes, bytesleft); 878 } 879 } else { 880 /* Map the dummy buffer on every page */ 881 for_each_sg(sgtab->sgl, sg, sgtab->nents, i) { 882 if (bytesleft < PAGE_SIZE) 883 mapbytes = bytesleft; 884 else 885 mapbytes = PAGE_SIZE; 886 sg_set_page(sg, virt_to_page(pl022->dummypage), 887 mapbytes, 0); 888 bytesleft -= mapbytes; 889 dev_dbg(&pl022->adev->dev, 890 "set RX/TX to dummy page %d bytes, %d left\n", 891 mapbytes, bytesleft); 892 893 } 894 } 895 BUG_ON(bytesleft); 896 } 897 898 /** 899 * configure_dma - configures the channels for the next transfer 900 * @pl022: SSP driver's private data structure 901 */ 902 static int configure_dma(struct pl022 *pl022) 903 { 904 struct dma_slave_config rx_conf = { 905 .src_addr = SSP_DR(pl022->phybase), 906 .direction = DMA_DEV_TO_MEM, 907 .device_fc = false, 908 }; 909 struct dma_slave_config tx_conf = { 910 .dst_addr = SSP_DR(pl022->phybase), 911 .direction = DMA_MEM_TO_DEV, 912 .device_fc = false, 913 }; 914 unsigned int pages; 915 int ret; 916 int rx_sglen, tx_sglen; 917 struct dma_chan *rxchan = pl022->dma_rx_channel; 918 struct dma_chan *txchan = pl022->dma_tx_channel; 919 struct dma_async_tx_descriptor *rxdesc; 920 struct dma_async_tx_descriptor *txdesc; 921 922 /* Check that the channels are available */ 923 if (!rxchan || !txchan) 924 return -ENODEV; 925 926 /* 927 * If supplied, the DMA burstsize should equal the FIFO trigger level. 928 * Notice that the DMA engine uses one-to-one mapping. Since we can 929 * not trigger on 2 elements this needs explicit mapping rather than 930 * calculation. 931 */ 932 switch (pl022->rx_lev_trig) { 933 case SSP_RX_1_OR_MORE_ELEM: 934 rx_conf.src_maxburst = 1; 935 break; 936 case SSP_RX_4_OR_MORE_ELEM: 937 rx_conf.src_maxburst = 4; 938 break; 939 case SSP_RX_8_OR_MORE_ELEM: 940 rx_conf.src_maxburst = 8; 941 break; 942 case SSP_RX_16_OR_MORE_ELEM: 943 rx_conf.src_maxburst = 16; 944 break; 945 case SSP_RX_32_OR_MORE_ELEM: 946 rx_conf.src_maxburst = 32; 947 break; 948 default: 949 rx_conf.src_maxburst = pl022->vendor->fifodepth >> 1; 950 break; 951 } 952 953 switch (pl022->tx_lev_trig) { 954 case SSP_TX_1_OR_MORE_EMPTY_LOC: 955 tx_conf.dst_maxburst = 1; 956 break; 957 case SSP_TX_4_OR_MORE_EMPTY_LOC: 958 tx_conf.dst_maxburst = 4; 959 break; 960 case SSP_TX_8_OR_MORE_EMPTY_LOC: 961 tx_conf.dst_maxburst = 8; 962 break; 963 case SSP_TX_16_OR_MORE_EMPTY_LOC: 964 tx_conf.dst_maxburst = 16; 965 break; 966 case SSP_TX_32_OR_MORE_EMPTY_LOC: 967 tx_conf.dst_maxburst = 32; 968 break; 969 default: 970 tx_conf.dst_maxburst = pl022->vendor->fifodepth >> 1; 971 break; 972 } 973 974 switch (pl022->read) { 975 case READING_NULL: 976 /* Use the same as for writing */ 977 rx_conf.src_addr_width = DMA_SLAVE_BUSWIDTH_UNDEFINED; 978 break; 979 case READING_U8: 980 rx_conf.src_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE; 981 break; 982 case READING_U16: 983 rx_conf.src_addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES; 984 break; 985 case READING_U32: 986 rx_conf.src_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES; 987 break; 988 } 989 990 switch (pl022->write) { 991 case WRITING_NULL: 992 /* Use the same as for reading */ 993 tx_conf.dst_addr_width = DMA_SLAVE_BUSWIDTH_UNDEFINED; 994 break; 995 case WRITING_U8: 996 tx_conf.dst_addr_width = DMA_SLAVE_BUSWIDTH_1_BYTE; 997 break; 998 case WRITING_U16: 999 tx_conf.dst_addr_width = DMA_SLAVE_BUSWIDTH_2_BYTES; 1000 break; 1001 case WRITING_U32: 1002 tx_conf.dst_addr_width = DMA_SLAVE_BUSWIDTH_4_BYTES; 1003 break; 1004 } 1005 1006 /* SPI pecularity: we need to read and write the same width */ 1007 if (rx_conf.src_addr_width == DMA_SLAVE_BUSWIDTH_UNDEFINED) 1008 rx_conf.src_addr_width = tx_conf.dst_addr_width; 1009 if (tx_conf.dst_addr_width == DMA_SLAVE_BUSWIDTH_UNDEFINED) 1010 tx_conf.dst_addr_width = rx_conf.src_addr_width; 1011 BUG_ON(rx_conf.src_addr_width != tx_conf.dst_addr_width); 1012 1013 dmaengine_slave_config(rxchan, &rx_conf); 1014 dmaengine_slave_config(txchan, &tx_conf); 1015 1016 /* Create sglists for the transfers */ 1017 pages = DIV_ROUND_UP(pl022->cur_transfer->len, PAGE_SIZE); 1018 dev_dbg(&pl022->adev->dev, "using %d pages for transfer\n", pages); 1019 1020 ret = sg_alloc_table(&pl022->sgt_rx, pages, GFP_ATOMIC); 1021 if (ret) 1022 goto err_alloc_rx_sg; 1023 1024 ret = sg_alloc_table(&pl022->sgt_tx, pages, GFP_ATOMIC); 1025 if (ret) 1026 goto err_alloc_tx_sg; 1027 1028 /* Fill in the scatterlists for the RX+TX buffers */ 1029 setup_dma_scatter(pl022, pl022->rx, 1030 pl022->cur_transfer->len, &pl022->sgt_rx); 1031 setup_dma_scatter(pl022, pl022->tx, 1032 pl022->cur_transfer->len, &pl022->sgt_tx); 1033 1034 /* Map DMA buffers */ 1035 rx_sglen = dma_map_sg(rxchan->device->dev, pl022->sgt_rx.sgl, 1036 pl022->sgt_rx.nents, DMA_FROM_DEVICE); 1037 if (!rx_sglen) 1038 goto err_rx_sgmap; 1039 1040 tx_sglen = dma_map_sg(txchan->device->dev, pl022->sgt_tx.sgl, 1041 pl022->sgt_tx.nents, DMA_TO_DEVICE); 1042 if (!tx_sglen) 1043 goto err_tx_sgmap; 1044 1045 /* Send both scatterlists */ 1046 rxdesc = dmaengine_prep_slave_sg(rxchan, 1047 pl022->sgt_rx.sgl, 1048 rx_sglen, 1049 DMA_DEV_TO_MEM, 1050 DMA_PREP_INTERRUPT | DMA_CTRL_ACK); 1051 if (!rxdesc) 1052 goto err_rxdesc; 1053 1054 txdesc = dmaengine_prep_slave_sg(txchan, 1055 pl022->sgt_tx.sgl, 1056 tx_sglen, 1057 DMA_MEM_TO_DEV, 1058 DMA_PREP_INTERRUPT | DMA_CTRL_ACK); 1059 if (!txdesc) 1060 goto err_txdesc; 1061 1062 /* Put the callback on the RX transfer only, that should finish last */ 1063 rxdesc->callback = dma_callback; 1064 rxdesc->callback_param = pl022; 1065 1066 /* Submit and fire RX and TX with TX last so we're ready to read! */ 1067 dmaengine_submit(rxdesc); 1068 dmaengine_submit(txdesc); 1069 dma_async_issue_pending(rxchan); 1070 dma_async_issue_pending(txchan); 1071 pl022->dma_running = true; 1072 1073 return 0; 1074 1075 err_txdesc: 1076 dmaengine_terminate_all(txchan); 1077 err_rxdesc: 1078 dmaengine_terminate_all(rxchan); 1079 dma_unmap_sg(txchan->device->dev, pl022->sgt_tx.sgl, 1080 pl022->sgt_tx.nents, DMA_TO_DEVICE); 1081 err_tx_sgmap: 1082 dma_unmap_sg(rxchan->device->dev, pl022->sgt_rx.sgl, 1083 pl022->sgt_tx.nents, DMA_FROM_DEVICE); 1084 err_rx_sgmap: 1085 sg_free_table(&pl022->sgt_tx); 1086 err_alloc_tx_sg: 1087 sg_free_table(&pl022->sgt_rx); 1088 err_alloc_rx_sg: 1089 return -ENOMEM; 1090 } 1091 1092 static int pl022_dma_probe(struct pl022 *pl022) 1093 { 1094 dma_cap_mask_t mask; 1095 1096 /* Try to acquire a generic DMA engine slave channel */ 1097 dma_cap_zero(mask); 1098 dma_cap_set(DMA_SLAVE, mask); 1099 /* 1100 * We need both RX and TX channels to do DMA, else do none 1101 * of them. 1102 */ 1103 pl022->dma_rx_channel = dma_request_channel(mask, 1104 pl022->master_info->dma_filter, 1105 pl022->master_info->dma_rx_param); 1106 if (!pl022->dma_rx_channel) { 1107 dev_dbg(&pl022->adev->dev, "no RX DMA channel!\n"); 1108 goto err_no_rxchan; 1109 } 1110 1111 pl022->dma_tx_channel = dma_request_channel(mask, 1112 pl022->master_info->dma_filter, 1113 pl022->master_info->dma_tx_param); 1114 if (!pl022->dma_tx_channel) { 1115 dev_dbg(&pl022->adev->dev, "no TX DMA channel!\n"); 1116 goto err_no_txchan; 1117 } 1118 1119 pl022->dummypage = kmalloc(PAGE_SIZE, GFP_KERNEL); 1120 if (!pl022->dummypage) { 1121 dev_dbg(&pl022->adev->dev, "no DMA dummypage!\n"); 1122 goto err_no_dummypage; 1123 } 1124 1125 dev_info(&pl022->adev->dev, "setup for DMA on RX %s, TX %s\n", 1126 dma_chan_name(pl022->dma_rx_channel), 1127 dma_chan_name(pl022->dma_tx_channel)); 1128 1129 return 0; 1130 1131 err_no_dummypage: 1132 dma_release_channel(pl022->dma_tx_channel); 1133 err_no_txchan: 1134 dma_release_channel(pl022->dma_rx_channel); 1135 pl022->dma_rx_channel = NULL; 1136 err_no_rxchan: 1137 dev_err(&pl022->adev->dev, 1138 "Failed to work in dma mode, work without dma!\n"); 1139 return -ENODEV; 1140 } 1141 1142 static int pl022_dma_autoprobe(struct pl022 *pl022) 1143 { 1144 struct device *dev = &pl022->adev->dev; 1145 1146 /* automatically configure DMA channels from platform, normally using DT */ 1147 pl022->dma_rx_channel = dma_request_slave_channel(dev, "rx"); 1148 if (!pl022->dma_rx_channel) 1149 goto err_no_rxchan; 1150 1151 pl022->dma_tx_channel = dma_request_slave_channel(dev, "tx"); 1152 if (!pl022->dma_tx_channel) 1153 goto err_no_txchan; 1154 1155 pl022->dummypage = kmalloc(PAGE_SIZE, GFP_KERNEL); 1156 if (!pl022->dummypage) 1157 goto err_no_dummypage; 1158 1159 return 0; 1160 1161 err_no_dummypage: 1162 dma_release_channel(pl022->dma_tx_channel); 1163 pl022->dma_tx_channel = NULL; 1164 err_no_txchan: 1165 dma_release_channel(pl022->dma_rx_channel); 1166 pl022->dma_rx_channel = NULL; 1167 err_no_rxchan: 1168 return -ENODEV; 1169 } 1170 1171 static void terminate_dma(struct pl022 *pl022) 1172 { 1173 struct dma_chan *rxchan = pl022->dma_rx_channel; 1174 struct dma_chan *txchan = pl022->dma_tx_channel; 1175 1176 dmaengine_terminate_all(rxchan); 1177 dmaengine_terminate_all(txchan); 1178 unmap_free_dma_scatter(pl022); 1179 pl022->dma_running = false; 1180 } 1181 1182 static void pl022_dma_remove(struct pl022 *pl022) 1183 { 1184 if (pl022->dma_running) 1185 terminate_dma(pl022); 1186 if (pl022->dma_tx_channel) 1187 dma_release_channel(pl022->dma_tx_channel); 1188 if (pl022->dma_rx_channel) 1189 dma_release_channel(pl022->dma_rx_channel); 1190 kfree(pl022->dummypage); 1191 } 1192 1193 #else 1194 static inline int configure_dma(struct pl022 *pl022) 1195 { 1196 return -ENODEV; 1197 } 1198 1199 static inline int pl022_dma_autoprobe(struct pl022 *pl022) 1200 { 1201 return 0; 1202 } 1203 1204 static inline int pl022_dma_probe(struct pl022 *pl022) 1205 { 1206 return 0; 1207 } 1208 1209 static inline void pl022_dma_remove(struct pl022 *pl022) 1210 { 1211 } 1212 #endif 1213 1214 /** 1215 * pl022_interrupt_handler - Interrupt handler for SSP controller 1216 * 1217 * This function handles interrupts generated for an interrupt based transfer. 1218 * If a receive overrun (ROR) interrupt is there then we disable SSP, flag the 1219 * current message's state as STATE_ERROR and schedule the tasklet 1220 * pump_transfers which will do the postprocessing of the current message by 1221 * calling giveback(). Otherwise it reads data from RX FIFO till there is no 1222 * more data, and writes data in TX FIFO till it is not full. If we complete 1223 * the transfer we move to the next transfer and schedule the tasklet. 1224 */ 1225 static irqreturn_t pl022_interrupt_handler(int irq, void *dev_id) 1226 { 1227 struct pl022 *pl022 = dev_id; 1228 struct spi_message *msg = pl022->cur_msg; 1229 u16 irq_status = 0; 1230 u16 flag = 0; 1231 1232 if (unlikely(!msg)) { 1233 dev_err(&pl022->adev->dev, 1234 "bad message state in interrupt handler"); 1235 /* Never fail */ 1236 return IRQ_HANDLED; 1237 } 1238 1239 /* Read the Interrupt Status Register */ 1240 irq_status = readw(SSP_MIS(pl022->virtbase)); 1241 1242 if (unlikely(!irq_status)) 1243 return IRQ_NONE; 1244 1245 /* 1246 * This handles the FIFO interrupts, the timeout 1247 * interrupts are flatly ignored, they cannot be 1248 * trusted. 1249 */ 1250 if (unlikely(irq_status & SSP_MIS_MASK_RORMIS)) { 1251 /* 1252 * Overrun interrupt - bail out since our Data has been 1253 * corrupted 1254 */ 1255 dev_err(&pl022->adev->dev, "FIFO overrun\n"); 1256 if (readw(SSP_SR(pl022->virtbase)) & SSP_SR_MASK_RFF) 1257 dev_err(&pl022->adev->dev, 1258 "RXFIFO is full\n"); 1259 if (readw(SSP_SR(pl022->virtbase)) & SSP_SR_MASK_TNF) 1260 dev_err(&pl022->adev->dev, 1261 "TXFIFO is full\n"); 1262 1263 /* 1264 * Disable and clear interrupts, disable SSP, 1265 * mark message with bad status so it can be 1266 * retried. 1267 */ 1268 writew(DISABLE_ALL_INTERRUPTS, 1269 SSP_IMSC(pl022->virtbase)); 1270 writew(CLEAR_ALL_INTERRUPTS, SSP_ICR(pl022->virtbase)); 1271 writew((readw(SSP_CR1(pl022->virtbase)) & 1272 (~SSP_CR1_MASK_SSE)), SSP_CR1(pl022->virtbase)); 1273 msg->state = STATE_ERROR; 1274 1275 /* Schedule message queue handler */ 1276 tasklet_schedule(&pl022->pump_transfers); 1277 return IRQ_HANDLED; 1278 } 1279 1280 readwriter(pl022); 1281 1282 if ((pl022->tx == pl022->tx_end) && (flag == 0)) { 1283 flag = 1; 1284 /* Disable Transmit interrupt, enable receive interrupt */ 1285 writew((readw(SSP_IMSC(pl022->virtbase)) & 1286 ~SSP_IMSC_MASK_TXIM) | SSP_IMSC_MASK_RXIM, 1287 SSP_IMSC(pl022->virtbase)); 1288 } 1289 1290 /* 1291 * Since all transactions must write as much as shall be read, 1292 * we can conclude the entire transaction once RX is complete. 1293 * At this point, all TX will always be finished. 1294 */ 1295 if (pl022->rx >= pl022->rx_end) { 1296 writew(DISABLE_ALL_INTERRUPTS, 1297 SSP_IMSC(pl022->virtbase)); 1298 writew(CLEAR_ALL_INTERRUPTS, SSP_ICR(pl022->virtbase)); 1299 if (unlikely(pl022->rx > pl022->rx_end)) { 1300 dev_warn(&pl022->adev->dev, "read %u surplus " 1301 "bytes (did you request an odd " 1302 "number of bytes on a 16bit bus?)\n", 1303 (u32) (pl022->rx - pl022->rx_end)); 1304 } 1305 /* Update total bytes transferred */ 1306 msg->actual_length += pl022->cur_transfer->len; 1307 if (pl022->cur_transfer->cs_change) 1308 pl022_cs_control(pl022, SSP_CHIP_DESELECT); 1309 /* Move to next transfer */ 1310 msg->state = next_transfer(pl022); 1311 tasklet_schedule(&pl022->pump_transfers); 1312 return IRQ_HANDLED; 1313 } 1314 1315 return IRQ_HANDLED; 1316 } 1317 1318 /** 1319 * This sets up the pointers to memory for the next message to 1320 * send out on the SPI bus. 1321 */ 1322 static int set_up_next_transfer(struct pl022 *pl022, 1323 struct spi_transfer *transfer) 1324 { 1325 int residue; 1326 1327 /* Sanity check the message for this bus width */ 1328 residue = pl022->cur_transfer->len % pl022->cur_chip->n_bytes; 1329 if (unlikely(residue != 0)) { 1330 dev_err(&pl022->adev->dev, 1331 "message of %u bytes to transmit but the current " 1332 "chip bus has a data width of %u bytes!\n", 1333 pl022->cur_transfer->len, 1334 pl022->cur_chip->n_bytes); 1335 dev_err(&pl022->adev->dev, "skipping this message\n"); 1336 return -EIO; 1337 } 1338 pl022->tx = (void *)transfer->tx_buf; 1339 pl022->tx_end = pl022->tx + pl022->cur_transfer->len; 1340 pl022->rx = (void *)transfer->rx_buf; 1341 pl022->rx_end = pl022->rx + pl022->cur_transfer->len; 1342 pl022->write = 1343 pl022->tx ? pl022->cur_chip->write : WRITING_NULL; 1344 pl022->read = pl022->rx ? pl022->cur_chip->read : READING_NULL; 1345 return 0; 1346 } 1347 1348 /** 1349 * pump_transfers - Tasklet function which schedules next transfer 1350 * when running in interrupt or DMA transfer mode. 1351 * @data: SSP driver private data structure 1352 * 1353 */ 1354 static void pump_transfers(unsigned long data) 1355 { 1356 struct pl022 *pl022 = (struct pl022 *) data; 1357 struct spi_message *message = NULL; 1358 struct spi_transfer *transfer = NULL; 1359 struct spi_transfer *previous = NULL; 1360 1361 /* Get current state information */ 1362 message = pl022->cur_msg; 1363 transfer = pl022->cur_transfer; 1364 1365 /* Handle for abort */ 1366 if (message->state == STATE_ERROR) { 1367 message->status = -EIO; 1368 giveback(pl022); 1369 return; 1370 } 1371 1372 /* Handle end of message */ 1373 if (message->state == STATE_DONE) { 1374 message->status = 0; 1375 giveback(pl022); 1376 return; 1377 } 1378 1379 /* Delay if requested at end of transfer before CS change */ 1380 if (message->state == STATE_RUNNING) { 1381 previous = list_entry(transfer->transfer_list.prev, 1382 struct spi_transfer, 1383 transfer_list); 1384 if (previous->delay_usecs) 1385 /* 1386 * FIXME: This runs in interrupt context. 1387 * Is this really smart? 1388 */ 1389 udelay(previous->delay_usecs); 1390 1391 /* Reselect chip select only if cs_change was requested */ 1392 if (previous->cs_change) 1393 pl022_cs_control(pl022, SSP_CHIP_SELECT); 1394 } else { 1395 /* STATE_START */ 1396 message->state = STATE_RUNNING; 1397 } 1398 1399 if (set_up_next_transfer(pl022, transfer)) { 1400 message->state = STATE_ERROR; 1401 message->status = -EIO; 1402 giveback(pl022); 1403 return; 1404 } 1405 /* Flush the FIFOs and let's go! */ 1406 flush(pl022); 1407 1408 if (pl022->cur_chip->enable_dma) { 1409 if (configure_dma(pl022)) { 1410 dev_dbg(&pl022->adev->dev, 1411 "configuration of DMA failed, fall back to interrupt mode\n"); 1412 goto err_config_dma; 1413 } 1414 return; 1415 } 1416 1417 err_config_dma: 1418 /* enable all interrupts except RX */ 1419 writew(ENABLE_ALL_INTERRUPTS & ~SSP_IMSC_MASK_RXIM, SSP_IMSC(pl022->virtbase)); 1420 } 1421 1422 static void do_interrupt_dma_transfer(struct pl022 *pl022) 1423 { 1424 /* 1425 * Default is to enable all interrupts except RX - 1426 * this will be enabled once TX is complete 1427 */ 1428 u32 irqflags = ENABLE_ALL_INTERRUPTS & ~SSP_IMSC_MASK_RXIM; 1429 1430 /* Enable target chip, if not already active */ 1431 if (!pl022->next_msg_cs_active) 1432 pl022_cs_control(pl022, SSP_CHIP_SELECT); 1433 1434 if (set_up_next_transfer(pl022, pl022->cur_transfer)) { 1435 /* Error path */ 1436 pl022->cur_msg->state = STATE_ERROR; 1437 pl022->cur_msg->status = -EIO; 1438 giveback(pl022); 1439 return; 1440 } 1441 /* If we're using DMA, set up DMA here */ 1442 if (pl022->cur_chip->enable_dma) { 1443 /* Configure DMA transfer */ 1444 if (configure_dma(pl022)) { 1445 dev_dbg(&pl022->adev->dev, 1446 "configuration of DMA failed, fall back to interrupt mode\n"); 1447 goto err_config_dma; 1448 } 1449 /* Disable interrupts in DMA mode, IRQ from DMA controller */ 1450 irqflags = DISABLE_ALL_INTERRUPTS; 1451 } 1452 err_config_dma: 1453 /* Enable SSP, turn on interrupts */ 1454 writew((readw(SSP_CR1(pl022->virtbase)) | SSP_CR1_MASK_SSE), 1455 SSP_CR1(pl022->virtbase)); 1456 writew(irqflags, SSP_IMSC(pl022->virtbase)); 1457 } 1458 1459 static void do_polling_transfer(struct pl022 *pl022) 1460 { 1461 struct spi_message *message = NULL; 1462 struct spi_transfer *transfer = NULL; 1463 struct spi_transfer *previous = NULL; 1464 struct chip_data *chip; 1465 unsigned long time, timeout; 1466 1467 chip = pl022->cur_chip; 1468 message = pl022->cur_msg; 1469 1470 while (message->state != STATE_DONE) { 1471 /* Handle for abort */ 1472 if (message->state == STATE_ERROR) 1473 break; 1474 transfer = pl022->cur_transfer; 1475 1476 /* Delay if requested at end of transfer */ 1477 if (message->state == STATE_RUNNING) { 1478 previous = 1479 list_entry(transfer->transfer_list.prev, 1480 struct spi_transfer, transfer_list); 1481 if (previous->delay_usecs) 1482 udelay(previous->delay_usecs); 1483 if (previous->cs_change) 1484 pl022_cs_control(pl022, SSP_CHIP_SELECT); 1485 } else { 1486 /* STATE_START */ 1487 message->state = STATE_RUNNING; 1488 if (!pl022->next_msg_cs_active) 1489 pl022_cs_control(pl022, SSP_CHIP_SELECT); 1490 } 1491 1492 /* Configuration Changing Per Transfer */ 1493 if (set_up_next_transfer(pl022, transfer)) { 1494 /* Error path */ 1495 message->state = STATE_ERROR; 1496 break; 1497 } 1498 /* Flush FIFOs and enable SSP */ 1499 flush(pl022); 1500 writew((readw(SSP_CR1(pl022->virtbase)) | SSP_CR1_MASK_SSE), 1501 SSP_CR1(pl022->virtbase)); 1502 1503 dev_dbg(&pl022->adev->dev, "polling transfer ongoing ...\n"); 1504 1505 timeout = jiffies + msecs_to_jiffies(SPI_POLLING_TIMEOUT); 1506 while (pl022->tx < pl022->tx_end || pl022->rx < pl022->rx_end) { 1507 time = jiffies; 1508 readwriter(pl022); 1509 if (time_after(time, timeout)) { 1510 dev_warn(&pl022->adev->dev, 1511 "%s: timeout!\n", __func__); 1512 message->state = STATE_ERROR; 1513 goto out; 1514 } 1515 cpu_relax(); 1516 } 1517 1518 /* Update total byte transferred */ 1519 message->actual_length += pl022->cur_transfer->len; 1520 if (pl022->cur_transfer->cs_change) 1521 pl022_cs_control(pl022, SSP_CHIP_DESELECT); 1522 /* Move to next transfer */ 1523 message->state = next_transfer(pl022); 1524 } 1525 out: 1526 /* Handle end of message */ 1527 if (message->state == STATE_DONE) 1528 message->status = 0; 1529 else 1530 message->status = -EIO; 1531 1532 giveback(pl022); 1533 return; 1534 } 1535 1536 static int pl022_transfer_one_message(struct spi_master *master, 1537 struct spi_message *msg) 1538 { 1539 struct pl022 *pl022 = spi_master_get_devdata(master); 1540 1541 /* Initial message state */ 1542 pl022->cur_msg = msg; 1543 msg->state = STATE_START; 1544 1545 pl022->cur_transfer = list_entry(msg->transfers.next, 1546 struct spi_transfer, transfer_list); 1547 1548 /* Setup the SPI using the per chip configuration */ 1549 pl022->cur_chip = spi_get_ctldata(msg->spi); 1550 pl022->cur_cs = pl022->chipselects[msg->spi->chip_select]; 1551 1552 restore_state(pl022); 1553 flush(pl022); 1554 1555 if (pl022->cur_chip->xfer_type == POLLING_TRANSFER) 1556 do_polling_transfer(pl022); 1557 else 1558 do_interrupt_dma_transfer(pl022); 1559 1560 return 0; 1561 } 1562 1563 static int pl022_prepare_transfer_hardware(struct spi_master *master) 1564 { 1565 struct pl022 *pl022 = spi_master_get_devdata(master); 1566 1567 /* 1568 * Just make sure we have all we need to run the transfer by syncing 1569 * with the runtime PM framework. 1570 */ 1571 pm_runtime_get_sync(&pl022->adev->dev); 1572 return 0; 1573 } 1574 1575 static int pl022_unprepare_transfer_hardware(struct spi_master *master) 1576 { 1577 struct pl022 *pl022 = spi_master_get_devdata(master); 1578 1579 /* nothing more to do - disable spi/ssp and power off */ 1580 writew((readw(SSP_CR1(pl022->virtbase)) & 1581 (~SSP_CR1_MASK_SSE)), SSP_CR1(pl022->virtbase)); 1582 1583 if (pl022->master_info->autosuspend_delay > 0) { 1584 pm_runtime_mark_last_busy(&pl022->adev->dev); 1585 pm_runtime_put_autosuspend(&pl022->adev->dev); 1586 } else { 1587 pm_runtime_put(&pl022->adev->dev); 1588 } 1589 1590 return 0; 1591 } 1592 1593 static int verify_controller_parameters(struct pl022 *pl022, 1594 struct pl022_config_chip const *chip_info) 1595 { 1596 if ((chip_info->iface < SSP_INTERFACE_MOTOROLA_SPI) 1597 || (chip_info->iface > SSP_INTERFACE_UNIDIRECTIONAL)) { 1598 dev_err(&pl022->adev->dev, 1599 "interface is configured incorrectly\n"); 1600 return -EINVAL; 1601 } 1602 if ((chip_info->iface == SSP_INTERFACE_UNIDIRECTIONAL) && 1603 (!pl022->vendor->unidir)) { 1604 dev_err(&pl022->adev->dev, 1605 "unidirectional mode not supported in this " 1606 "hardware version\n"); 1607 return -EINVAL; 1608 } 1609 if ((chip_info->hierarchy != SSP_MASTER) 1610 && (chip_info->hierarchy != SSP_SLAVE)) { 1611 dev_err(&pl022->adev->dev, 1612 "hierarchy is configured incorrectly\n"); 1613 return -EINVAL; 1614 } 1615 if ((chip_info->com_mode != INTERRUPT_TRANSFER) 1616 && (chip_info->com_mode != DMA_TRANSFER) 1617 && (chip_info->com_mode != POLLING_TRANSFER)) { 1618 dev_err(&pl022->adev->dev, 1619 "Communication mode is configured incorrectly\n"); 1620 return -EINVAL; 1621 } 1622 switch (chip_info->rx_lev_trig) { 1623 case SSP_RX_1_OR_MORE_ELEM: 1624 case SSP_RX_4_OR_MORE_ELEM: 1625 case SSP_RX_8_OR_MORE_ELEM: 1626 /* These are always OK, all variants can handle this */ 1627 break; 1628 case SSP_RX_16_OR_MORE_ELEM: 1629 if (pl022->vendor->fifodepth < 16) { 1630 dev_err(&pl022->adev->dev, 1631 "RX FIFO Trigger Level is configured incorrectly\n"); 1632 return -EINVAL; 1633 } 1634 break; 1635 case SSP_RX_32_OR_MORE_ELEM: 1636 if (pl022->vendor->fifodepth < 32) { 1637 dev_err(&pl022->adev->dev, 1638 "RX FIFO Trigger Level is configured incorrectly\n"); 1639 return -EINVAL; 1640 } 1641 break; 1642 default: 1643 dev_err(&pl022->adev->dev, 1644 "RX FIFO Trigger Level is configured incorrectly\n"); 1645 return -EINVAL; 1646 break; 1647 } 1648 switch (chip_info->tx_lev_trig) { 1649 case SSP_TX_1_OR_MORE_EMPTY_LOC: 1650 case SSP_TX_4_OR_MORE_EMPTY_LOC: 1651 case SSP_TX_8_OR_MORE_EMPTY_LOC: 1652 /* These are always OK, all variants can handle this */ 1653 break; 1654 case SSP_TX_16_OR_MORE_EMPTY_LOC: 1655 if (pl022->vendor->fifodepth < 16) { 1656 dev_err(&pl022->adev->dev, 1657 "TX FIFO Trigger Level is configured incorrectly\n"); 1658 return -EINVAL; 1659 } 1660 break; 1661 case SSP_TX_32_OR_MORE_EMPTY_LOC: 1662 if (pl022->vendor->fifodepth < 32) { 1663 dev_err(&pl022->adev->dev, 1664 "TX FIFO Trigger Level is configured incorrectly\n"); 1665 return -EINVAL; 1666 } 1667 break; 1668 default: 1669 dev_err(&pl022->adev->dev, 1670 "TX FIFO Trigger Level is configured incorrectly\n"); 1671 return -EINVAL; 1672 break; 1673 } 1674 if (chip_info->iface == SSP_INTERFACE_NATIONAL_MICROWIRE) { 1675 if ((chip_info->ctrl_len < SSP_BITS_4) 1676 || (chip_info->ctrl_len > SSP_BITS_32)) { 1677 dev_err(&pl022->adev->dev, 1678 "CTRL LEN is configured incorrectly\n"); 1679 return -EINVAL; 1680 } 1681 if ((chip_info->wait_state != SSP_MWIRE_WAIT_ZERO) 1682 && (chip_info->wait_state != SSP_MWIRE_WAIT_ONE)) { 1683 dev_err(&pl022->adev->dev, 1684 "Wait State is configured incorrectly\n"); 1685 return -EINVAL; 1686 } 1687 /* Half duplex is only available in the ST Micro version */ 1688 if (pl022->vendor->extended_cr) { 1689 if ((chip_info->duplex != 1690 SSP_MICROWIRE_CHANNEL_FULL_DUPLEX) 1691 && (chip_info->duplex != 1692 SSP_MICROWIRE_CHANNEL_HALF_DUPLEX)) { 1693 dev_err(&pl022->adev->dev, 1694 "Microwire duplex mode is configured incorrectly\n"); 1695 return -EINVAL; 1696 } 1697 } else { 1698 if (chip_info->duplex != SSP_MICROWIRE_CHANNEL_FULL_DUPLEX) 1699 dev_err(&pl022->adev->dev, 1700 "Microwire half duplex mode requested," 1701 " but this is only available in the" 1702 " ST version of PL022\n"); 1703 return -EINVAL; 1704 } 1705 } 1706 return 0; 1707 } 1708 1709 static inline u32 spi_rate(u32 rate, u16 cpsdvsr, u16 scr) 1710 { 1711 return rate / (cpsdvsr * (1 + scr)); 1712 } 1713 1714 static int calculate_effective_freq(struct pl022 *pl022, int freq, struct 1715 ssp_clock_params * clk_freq) 1716 { 1717 /* Lets calculate the frequency parameters */ 1718 u16 cpsdvsr = CPSDVR_MIN, scr = SCR_MIN; 1719 u32 rate, max_tclk, min_tclk, best_freq = 0, best_cpsdvsr = 0, 1720 best_scr = 0, tmp, found = 0; 1721 1722 rate = clk_get_rate(pl022->clk); 1723 /* cpsdvscr = 2 & scr 0 */ 1724 max_tclk = spi_rate(rate, CPSDVR_MIN, SCR_MIN); 1725 /* cpsdvsr = 254 & scr = 255 */ 1726 min_tclk = spi_rate(rate, CPSDVR_MAX, SCR_MAX); 1727 1728 if (freq > max_tclk) 1729 dev_warn(&pl022->adev->dev, 1730 "Max speed that can be programmed is %d Hz, you requested %d\n", 1731 max_tclk, freq); 1732 1733 if (freq < min_tclk) { 1734 dev_err(&pl022->adev->dev, 1735 "Requested frequency: %d Hz is less than minimum possible %d Hz\n", 1736 freq, min_tclk); 1737 return -EINVAL; 1738 } 1739 1740 /* 1741 * best_freq will give closest possible available rate (<= requested 1742 * freq) for all values of scr & cpsdvsr. 1743 */ 1744 while ((cpsdvsr <= CPSDVR_MAX) && !found) { 1745 while (scr <= SCR_MAX) { 1746 tmp = spi_rate(rate, cpsdvsr, scr); 1747 1748 if (tmp > freq) { 1749 /* we need lower freq */ 1750 scr++; 1751 continue; 1752 } 1753 1754 /* 1755 * If found exact value, mark found and break. 1756 * If found more closer value, update and break. 1757 */ 1758 if (tmp > best_freq) { 1759 best_freq = tmp; 1760 best_cpsdvsr = cpsdvsr; 1761 best_scr = scr; 1762 1763 if (tmp == freq) 1764 found = 1; 1765 } 1766 /* 1767 * increased scr will give lower rates, which are not 1768 * required 1769 */ 1770 break; 1771 } 1772 cpsdvsr += 2; 1773 scr = SCR_MIN; 1774 } 1775 1776 WARN(!best_freq, "pl022: Matching cpsdvsr and scr not found for %d Hz rate \n", 1777 freq); 1778 1779 clk_freq->cpsdvsr = (u8) (best_cpsdvsr & 0xFF); 1780 clk_freq->scr = (u8) (best_scr & 0xFF); 1781 dev_dbg(&pl022->adev->dev, 1782 "SSP Target Frequency is: %u, Effective Frequency is %u\n", 1783 freq, best_freq); 1784 dev_dbg(&pl022->adev->dev, "SSP cpsdvsr = %d, scr = %d\n", 1785 clk_freq->cpsdvsr, clk_freq->scr); 1786 1787 return 0; 1788 } 1789 1790 /* 1791 * A piece of default chip info unless the platform 1792 * supplies it. 1793 */ 1794 static const struct pl022_config_chip pl022_default_chip_info = { 1795 .com_mode = POLLING_TRANSFER, 1796 .iface = SSP_INTERFACE_MOTOROLA_SPI, 1797 .hierarchy = SSP_SLAVE, 1798 .slave_tx_disable = DO_NOT_DRIVE_TX, 1799 .rx_lev_trig = SSP_RX_1_OR_MORE_ELEM, 1800 .tx_lev_trig = SSP_TX_1_OR_MORE_EMPTY_LOC, 1801 .ctrl_len = SSP_BITS_8, 1802 .wait_state = SSP_MWIRE_WAIT_ZERO, 1803 .duplex = SSP_MICROWIRE_CHANNEL_FULL_DUPLEX, 1804 .cs_control = null_cs_control, 1805 }; 1806 1807 /** 1808 * pl022_setup - setup function registered to SPI master framework 1809 * @spi: spi device which is requesting setup 1810 * 1811 * This function is registered to the SPI framework for this SPI master 1812 * controller. If it is the first time when setup is called by this device, 1813 * this function will initialize the runtime state for this chip and save 1814 * the same in the device structure. Else it will update the runtime info 1815 * with the updated chip info. Nothing is really being written to the 1816 * controller hardware here, that is not done until the actual transfer 1817 * commence. 1818 */ 1819 static int pl022_setup(struct spi_device *spi) 1820 { 1821 struct pl022_config_chip const *chip_info; 1822 struct pl022_config_chip chip_info_dt; 1823 struct chip_data *chip; 1824 struct ssp_clock_params clk_freq = { .cpsdvsr = 0, .scr = 0}; 1825 int status = 0; 1826 struct pl022 *pl022 = spi_master_get_devdata(spi->master); 1827 unsigned int bits = spi->bits_per_word; 1828 u32 tmp; 1829 struct device_node *np = spi->dev.of_node; 1830 1831 if (!spi->max_speed_hz) 1832 return -EINVAL; 1833 1834 /* Get controller_state if one is supplied */ 1835 chip = spi_get_ctldata(spi); 1836 1837 if (chip == NULL) { 1838 chip = kzalloc(sizeof(struct chip_data), GFP_KERNEL); 1839 if (!chip) { 1840 dev_err(&spi->dev, 1841 "cannot allocate controller state\n"); 1842 return -ENOMEM; 1843 } 1844 dev_dbg(&spi->dev, 1845 "allocated memory for controller's runtime state\n"); 1846 } 1847 1848 /* Get controller data if one is supplied */ 1849 chip_info = spi->controller_data; 1850 1851 if (chip_info == NULL) { 1852 if (np) { 1853 chip_info_dt = pl022_default_chip_info; 1854 1855 chip_info_dt.hierarchy = SSP_MASTER; 1856 of_property_read_u32(np, "pl022,interface", 1857 &chip_info_dt.iface); 1858 of_property_read_u32(np, "pl022,com-mode", 1859 &chip_info_dt.com_mode); 1860 of_property_read_u32(np, "pl022,rx-level-trig", 1861 &chip_info_dt.rx_lev_trig); 1862 of_property_read_u32(np, "pl022,tx-level-trig", 1863 &chip_info_dt.tx_lev_trig); 1864 of_property_read_u32(np, "pl022,ctrl-len", 1865 &chip_info_dt.ctrl_len); 1866 of_property_read_u32(np, "pl022,wait-state", 1867 &chip_info_dt.wait_state); 1868 of_property_read_u32(np, "pl022,duplex", 1869 &chip_info_dt.duplex); 1870 1871 chip_info = &chip_info_dt; 1872 } else { 1873 chip_info = &pl022_default_chip_info; 1874 /* spi_board_info.controller_data not is supplied */ 1875 dev_dbg(&spi->dev, 1876 "using default controller_data settings\n"); 1877 } 1878 } else 1879 dev_dbg(&spi->dev, 1880 "using user supplied controller_data settings\n"); 1881 1882 /* 1883 * We can override with custom divisors, else we use the board 1884 * frequency setting 1885 */ 1886 if ((0 == chip_info->clk_freq.cpsdvsr) 1887 && (0 == chip_info->clk_freq.scr)) { 1888 status = calculate_effective_freq(pl022, 1889 spi->max_speed_hz, 1890 &clk_freq); 1891 if (status < 0) 1892 goto err_config_params; 1893 } else { 1894 memcpy(&clk_freq, &chip_info->clk_freq, sizeof(clk_freq)); 1895 if ((clk_freq.cpsdvsr % 2) != 0) 1896 clk_freq.cpsdvsr = 1897 clk_freq.cpsdvsr - 1; 1898 } 1899 if ((clk_freq.cpsdvsr < CPSDVR_MIN) 1900 || (clk_freq.cpsdvsr > CPSDVR_MAX)) { 1901 status = -EINVAL; 1902 dev_err(&spi->dev, 1903 "cpsdvsr is configured incorrectly\n"); 1904 goto err_config_params; 1905 } 1906 1907 status = verify_controller_parameters(pl022, chip_info); 1908 if (status) { 1909 dev_err(&spi->dev, "controller data is incorrect"); 1910 goto err_config_params; 1911 } 1912 1913 pl022->rx_lev_trig = chip_info->rx_lev_trig; 1914 pl022->tx_lev_trig = chip_info->tx_lev_trig; 1915 1916 /* Now set controller state based on controller data */ 1917 chip->xfer_type = chip_info->com_mode; 1918 if (!chip_info->cs_control) { 1919 chip->cs_control = null_cs_control; 1920 if (!gpio_is_valid(pl022->chipselects[spi->chip_select])) 1921 dev_warn(&spi->dev, 1922 "invalid chip select\n"); 1923 } else 1924 chip->cs_control = chip_info->cs_control; 1925 1926 /* Check bits per word with vendor specific range */ 1927 if ((bits <= 3) || (bits > pl022->vendor->max_bpw)) { 1928 status = -ENOTSUPP; 1929 dev_err(&spi->dev, "illegal data size for this controller!\n"); 1930 dev_err(&spi->dev, "This controller can only handle 4 <= n <= %d bit words\n", 1931 pl022->vendor->max_bpw); 1932 goto err_config_params; 1933 } else if (bits <= 8) { 1934 dev_dbg(&spi->dev, "4 <= n <=8 bits per word\n"); 1935 chip->n_bytes = 1; 1936 chip->read = READING_U8; 1937 chip->write = WRITING_U8; 1938 } else if (bits <= 16) { 1939 dev_dbg(&spi->dev, "9 <= n <= 16 bits per word\n"); 1940 chip->n_bytes = 2; 1941 chip->read = READING_U16; 1942 chip->write = WRITING_U16; 1943 } else { 1944 dev_dbg(&spi->dev, "17 <= n <= 32 bits per word\n"); 1945 chip->n_bytes = 4; 1946 chip->read = READING_U32; 1947 chip->write = WRITING_U32; 1948 } 1949 1950 /* Now Initialize all register settings required for this chip */ 1951 chip->cr0 = 0; 1952 chip->cr1 = 0; 1953 chip->dmacr = 0; 1954 chip->cpsr = 0; 1955 if ((chip_info->com_mode == DMA_TRANSFER) 1956 && ((pl022->master_info)->enable_dma)) { 1957 chip->enable_dma = true; 1958 dev_dbg(&spi->dev, "DMA mode set in controller state\n"); 1959 SSP_WRITE_BITS(chip->dmacr, SSP_DMA_ENABLED, 1960 SSP_DMACR_MASK_RXDMAE, 0); 1961 SSP_WRITE_BITS(chip->dmacr, SSP_DMA_ENABLED, 1962 SSP_DMACR_MASK_TXDMAE, 1); 1963 } else { 1964 chip->enable_dma = false; 1965 dev_dbg(&spi->dev, "DMA mode NOT set in controller state\n"); 1966 SSP_WRITE_BITS(chip->dmacr, SSP_DMA_DISABLED, 1967 SSP_DMACR_MASK_RXDMAE, 0); 1968 SSP_WRITE_BITS(chip->dmacr, SSP_DMA_DISABLED, 1969 SSP_DMACR_MASK_TXDMAE, 1); 1970 } 1971 1972 chip->cpsr = clk_freq.cpsdvsr; 1973 1974 /* Special setup for the ST micro extended control registers */ 1975 if (pl022->vendor->extended_cr) { 1976 u32 etx; 1977 1978 if (pl022->vendor->pl023) { 1979 /* These bits are only in the PL023 */ 1980 SSP_WRITE_BITS(chip->cr1, chip_info->clkdelay, 1981 SSP_CR1_MASK_FBCLKDEL_ST, 13); 1982 } else { 1983 /* These bits are in the PL022 but not PL023 */ 1984 SSP_WRITE_BITS(chip->cr0, chip_info->duplex, 1985 SSP_CR0_MASK_HALFDUP_ST, 5); 1986 SSP_WRITE_BITS(chip->cr0, chip_info->ctrl_len, 1987 SSP_CR0_MASK_CSS_ST, 16); 1988 SSP_WRITE_BITS(chip->cr0, chip_info->iface, 1989 SSP_CR0_MASK_FRF_ST, 21); 1990 SSP_WRITE_BITS(chip->cr1, chip_info->wait_state, 1991 SSP_CR1_MASK_MWAIT_ST, 6); 1992 } 1993 SSP_WRITE_BITS(chip->cr0, bits - 1, 1994 SSP_CR0_MASK_DSS_ST, 0); 1995 1996 if (spi->mode & SPI_LSB_FIRST) { 1997 tmp = SSP_RX_LSB; 1998 etx = SSP_TX_LSB; 1999 } else { 2000 tmp = SSP_RX_MSB; 2001 etx = SSP_TX_MSB; 2002 } 2003 SSP_WRITE_BITS(chip->cr1, tmp, SSP_CR1_MASK_RENDN_ST, 4); 2004 SSP_WRITE_BITS(chip->cr1, etx, SSP_CR1_MASK_TENDN_ST, 5); 2005 SSP_WRITE_BITS(chip->cr1, chip_info->rx_lev_trig, 2006 SSP_CR1_MASK_RXIFLSEL_ST, 7); 2007 SSP_WRITE_BITS(chip->cr1, chip_info->tx_lev_trig, 2008 SSP_CR1_MASK_TXIFLSEL_ST, 10); 2009 } else { 2010 SSP_WRITE_BITS(chip->cr0, bits - 1, 2011 SSP_CR0_MASK_DSS, 0); 2012 SSP_WRITE_BITS(chip->cr0, chip_info->iface, 2013 SSP_CR0_MASK_FRF, 4); 2014 } 2015 2016 /* Stuff that is common for all versions */ 2017 if (spi->mode & SPI_CPOL) 2018 tmp = SSP_CLK_POL_IDLE_HIGH; 2019 else 2020 tmp = SSP_CLK_POL_IDLE_LOW; 2021 SSP_WRITE_BITS(chip->cr0, tmp, SSP_CR0_MASK_SPO, 6); 2022 2023 if (spi->mode & SPI_CPHA) 2024 tmp = SSP_CLK_SECOND_EDGE; 2025 else 2026 tmp = SSP_CLK_FIRST_EDGE; 2027 SSP_WRITE_BITS(chip->cr0, tmp, SSP_CR0_MASK_SPH, 7); 2028 2029 SSP_WRITE_BITS(chip->cr0, clk_freq.scr, SSP_CR0_MASK_SCR, 8); 2030 /* Loopback is available on all versions except PL023 */ 2031 if (pl022->vendor->loopback) { 2032 if (spi->mode & SPI_LOOP) 2033 tmp = LOOPBACK_ENABLED; 2034 else 2035 tmp = LOOPBACK_DISABLED; 2036 SSP_WRITE_BITS(chip->cr1, tmp, SSP_CR1_MASK_LBM, 0); 2037 } 2038 SSP_WRITE_BITS(chip->cr1, SSP_DISABLED, SSP_CR1_MASK_SSE, 1); 2039 SSP_WRITE_BITS(chip->cr1, chip_info->hierarchy, SSP_CR1_MASK_MS, 2); 2040 SSP_WRITE_BITS(chip->cr1, chip_info->slave_tx_disable, SSP_CR1_MASK_SOD, 2041 3); 2042 2043 /* Save controller_state */ 2044 spi_set_ctldata(spi, chip); 2045 return status; 2046 err_config_params: 2047 spi_set_ctldata(spi, NULL); 2048 kfree(chip); 2049 return status; 2050 } 2051 2052 /** 2053 * pl022_cleanup - cleanup function registered to SPI master framework 2054 * @spi: spi device which is requesting cleanup 2055 * 2056 * This function is registered to the SPI framework for this SPI master 2057 * controller. It will free the runtime state of chip. 2058 */ 2059 static void pl022_cleanup(struct spi_device *spi) 2060 { 2061 struct chip_data *chip = spi_get_ctldata(spi); 2062 2063 spi_set_ctldata(spi, NULL); 2064 kfree(chip); 2065 } 2066 2067 static struct pl022_ssp_controller * 2068 pl022_platform_data_dt_get(struct device *dev) 2069 { 2070 struct device_node *np = dev->of_node; 2071 struct pl022_ssp_controller *pd; 2072 u32 tmp; 2073 2074 if (!np) { 2075 dev_err(dev, "no dt node defined\n"); 2076 return NULL; 2077 } 2078 2079 pd = devm_kzalloc(dev, sizeof(struct pl022_ssp_controller), GFP_KERNEL); 2080 if (!pd) { 2081 dev_err(dev, "cannot allocate platform data memory\n"); 2082 return NULL; 2083 } 2084 2085 pd->bus_id = -1; 2086 pd->enable_dma = 1; 2087 of_property_read_u32(np, "num-cs", &tmp); 2088 pd->num_chipselect = tmp; 2089 of_property_read_u32(np, "pl022,autosuspend-delay", 2090 &pd->autosuspend_delay); 2091 pd->rt = of_property_read_bool(np, "pl022,rt"); 2092 2093 return pd; 2094 } 2095 2096 static int pl022_probe(struct amba_device *adev, const struct amba_id *id) 2097 { 2098 struct device *dev = &adev->dev; 2099 struct pl022_ssp_controller *platform_info = adev->dev.platform_data; 2100 struct spi_master *master; 2101 struct pl022 *pl022 = NULL; /*Data for this driver */ 2102 struct device_node *np = adev->dev.of_node; 2103 int status = 0, i, num_cs; 2104 2105 dev_info(&adev->dev, 2106 "ARM PL022 driver, device ID: 0x%08x\n", adev->periphid); 2107 if (!platform_info && IS_ENABLED(CONFIG_OF)) 2108 platform_info = pl022_platform_data_dt_get(dev); 2109 2110 if (!platform_info) { 2111 dev_err(dev, "probe: no platform data defined\n"); 2112 return -ENODEV; 2113 } 2114 2115 if (platform_info->num_chipselect) { 2116 num_cs = platform_info->num_chipselect; 2117 } else { 2118 dev_err(dev, "probe: no chip select defined\n"); 2119 return -ENODEV; 2120 } 2121 2122 /* Allocate master with space for data */ 2123 master = spi_alloc_master(dev, sizeof(struct pl022)); 2124 if (master == NULL) { 2125 dev_err(&adev->dev, "probe - cannot alloc SPI master\n"); 2126 return -ENOMEM; 2127 } 2128 2129 pl022 = spi_master_get_devdata(master); 2130 pl022->master = master; 2131 pl022->master_info = platform_info; 2132 pl022->adev = adev; 2133 pl022->vendor = id->data; 2134 pl022->chipselects = devm_kzalloc(dev, num_cs * sizeof(int), 2135 GFP_KERNEL); 2136 2137 pl022->pinctrl = devm_pinctrl_get(dev); 2138 if (IS_ERR(pl022->pinctrl)) { 2139 status = PTR_ERR(pl022->pinctrl); 2140 goto err_no_pinctrl; 2141 } 2142 2143 pl022->pins_default = pinctrl_lookup_state(pl022->pinctrl, 2144 PINCTRL_STATE_DEFAULT); 2145 /* enable pins to be muxed in and configured */ 2146 if (!IS_ERR(pl022->pins_default)) { 2147 status = pinctrl_select_state(pl022->pinctrl, 2148 pl022->pins_default); 2149 if (status) 2150 dev_err(dev, "could not set default pins\n"); 2151 } else 2152 dev_err(dev, "could not get default pinstate\n"); 2153 2154 pl022->pins_idle = pinctrl_lookup_state(pl022->pinctrl, 2155 PINCTRL_STATE_IDLE); 2156 if (IS_ERR(pl022->pins_idle)) 2157 dev_dbg(dev, "could not get idle pinstate\n"); 2158 2159 pl022->pins_sleep = pinctrl_lookup_state(pl022->pinctrl, 2160 PINCTRL_STATE_SLEEP); 2161 if (IS_ERR(pl022->pins_sleep)) 2162 dev_dbg(dev, "could not get sleep pinstate\n"); 2163 2164 /* 2165 * Bus Number Which has been Assigned to this SSP controller 2166 * on this board 2167 */ 2168 master->bus_num = platform_info->bus_id; 2169 master->num_chipselect = num_cs; 2170 master->cleanup = pl022_cleanup; 2171 master->setup = pl022_setup; 2172 master->prepare_transfer_hardware = pl022_prepare_transfer_hardware; 2173 master->transfer_one_message = pl022_transfer_one_message; 2174 master->unprepare_transfer_hardware = pl022_unprepare_transfer_hardware; 2175 master->rt = platform_info->rt; 2176 master->dev.of_node = dev->of_node; 2177 2178 if (platform_info->num_chipselect && platform_info->chipselects) { 2179 for (i = 0; i < num_cs; i++) 2180 pl022->chipselects[i] = platform_info->chipselects[i]; 2181 } else if (IS_ENABLED(CONFIG_OF)) { 2182 for (i = 0; i < num_cs; i++) { 2183 int cs_gpio = of_get_named_gpio(np, "cs-gpios", i); 2184 2185 if (cs_gpio == -EPROBE_DEFER) { 2186 status = -EPROBE_DEFER; 2187 goto err_no_gpio; 2188 } 2189 2190 pl022->chipselects[i] = cs_gpio; 2191 2192 if (gpio_is_valid(cs_gpio)) { 2193 if (devm_gpio_request(dev, cs_gpio, "ssp-pl022")) 2194 dev_err(&adev->dev, 2195 "could not request %d gpio\n", 2196 cs_gpio); 2197 else if (gpio_direction_output(cs_gpio, 1)) 2198 dev_err(&adev->dev, 2199 "could set gpio %d as output\n", 2200 cs_gpio); 2201 } 2202 } 2203 } 2204 2205 /* 2206 * Supports mode 0-3, loopback, and active low CS. Transfers are 2207 * always MS bit first on the original pl022. 2208 */ 2209 master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LOOP; 2210 if (pl022->vendor->extended_cr) 2211 master->mode_bits |= SPI_LSB_FIRST; 2212 2213 dev_dbg(&adev->dev, "BUSNO: %d\n", master->bus_num); 2214 2215 status = amba_request_regions(adev, NULL); 2216 if (status) 2217 goto err_no_ioregion; 2218 2219 pl022->phybase = adev->res.start; 2220 pl022->virtbase = devm_ioremap(dev, adev->res.start, 2221 resource_size(&adev->res)); 2222 if (pl022->virtbase == NULL) { 2223 status = -ENOMEM; 2224 goto err_no_ioremap; 2225 } 2226 printk(KERN_INFO "pl022: mapped registers from 0x%08x to %p\n", 2227 adev->res.start, pl022->virtbase); 2228 2229 pl022->clk = devm_clk_get(&adev->dev, NULL); 2230 if (IS_ERR(pl022->clk)) { 2231 status = PTR_ERR(pl022->clk); 2232 dev_err(&adev->dev, "could not retrieve SSP/SPI bus clock\n"); 2233 goto err_no_clk; 2234 } 2235 2236 status = clk_prepare(pl022->clk); 2237 if (status) { 2238 dev_err(&adev->dev, "could not prepare SSP/SPI bus clock\n"); 2239 goto err_clk_prep; 2240 } 2241 2242 status = clk_enable(pl022->clk); 2243 if (status) { 2244 dev_err(&adev->dev, "could not enable SSP/SPI bus clock\n"); 2245 goto err_no_clk_en; 2246 } 2247 2248 /* Initialize transfer pump */ 2249 tasklet_init(&pl022->pump_transfers, pump_transfers, 2250 (unsigned long)pl022); 2251 2252 /* Disable SSP */ 2253 writew((readw(SSP_CR1(pl022->virtbase)) & (~SSP_CR1_MASK_SSE)), 2254 SSP_CR1(pl022->virtbase)); 2255 load_ssp_default_config(pl022); 2256 2257 status = devm_request_irq(dev, adev->irq[0], pl022_interrupt_handler, 2258 0, "pl022", pl022); 2259 if (status < 0) { 2260 dev_err(&adev->dev, "probe - cannot get IRQ (%d)\n", status); 2261 goto err_no_irq; 2262 } 2263 2264 /* Get DMA channels, try autoconfiguration first */ 2265 status = pl022_dma_autoprobe(pl022); 2266 2267 /* If that failed, use channels from platform_info */ 2268 if (status == 0) 2269 platform_info->enable_dma = 1; 2270 else if (platform_info->enable_dma) { 2271 status = pl022_dma_probe(pl022); 2272 if (status != 0) 2273 platform_info->enable_dma = 0; 2274 } 2275 2276 /* Register with the SPI framework */ 2277 amba_set_drvdata(adev, pl022); 2278 status = spi_register_master(master); 2279 if (status != 0) { 2280 dev_err(&adev->dev, 2281 "probe - problem registering spi master\n"); 2282 goto err_spi_register; 2283 } 2284 dev_dbg(dev, "probe succeeded\n"); 2285 2286 /* let runtime pm put suspend */ 2287 if (platform_info->autosuspend_delay > 0) { 2288 dev_info(&adev->dev, 2289 "will use autosuspend for runtime pm, delay %dms\n", 2290 platform_info->autosuspend_delay); 2291 pm_runtime_set_autosuspend_delay(dev, 2292 platform_info->autosuspend_delay); 2293 pm_runtime_use_autosuspend(dev); 2294 } 2295 pm_runtime_put(dev); 2296 2297 return 0; 2298 2299 err_spi_register: 2300 if (platform_info->enable_dma) 2301 pl022_dma_remove(pl022); 2302 err_no_irq: 2303 clk_disable(pl022->clk); 2304 err_no_clk_en: 2305 clk_unprepare(pl022->clk); 2306 err_clk_prep: 2307 err_no_clk: 2308 err_no_ioremap: 2309 amba_release_regions(adev); 2310 err_no_ioregion: 2311 err_no_gpio: 2312 err_no_pinctrl: 2313 spi_master_put(master); 2314 return status; 2315 } 2316 2317 static int 2318 pl022_remove(struct amba_device *adev) 2319 { 2320 struct pl022 *pl022 = amba_get_drvdata(adev); 2321 2322 if (!pl022) 2323 return 0; 2324 2325 /* 2326 * undo pm_runtime_put() in probe. I assume that we're not 2327 * accessing the primecell here. 2328 */ 2329 pm_runtime_get_noresume(&adev->dev); 2330 2331 load_ssp_default_config(pl022); 2332 if (pl022->master_info->enable_dma) 2333 pl022_dma_remove(pl022); 2334 2335 clk_disable(pl022->clk); 2336 clk_unprepare(pl022->clk); 2337 amba_release_regions(adev); 2338 tasklet_disable(&pl022->pump_transfers); 2339 spi_unregister_master(pl022->master); 2340 amba_set_drvdata(adev, NULL); 2341 return 0; 2342 } 2343 2344 #if defined(CONFIG_SUSPEND) || defined(CONFIG_PM_RUNTIME) 2345 /* 2346 * These two functions are used from both suspend/resume and 2347 * the runtime counterparts to handle external resources like 2348 * clocks, pins and regulators when going to sleep. 2349 */ 2350 static void pl022_suspend_resources(struct pl022 *pl022, bool runtime) 2351 { 2352 int ret; 2353 struct pinctrl_state *pins_state; 2354 2355 clk_disable(pl022->clk); 2356 2357 pins_state = runtime ? pl022->pins_idle : pl022->pins_sleep; 2358 /* Optionally let pins go into sleep states */ 2359 if (!IS_ERR(pins_state)) { 2360 ret = pinctrl_select_state(pl022->pinctrl, pins_state); 2361 if (ret) 2362 dev_err(&pl022->adev->dev, "could not set %s pins\n", 2363 runtime ? "idle" : "sleep"); 2364 } 2365 } 2366 2367 static void pl022_resume_resources(struct pl022 *pl022, bool runtime) 2368 { 2369 int ret; 2370 2371 /* Optionaly enable pins to be muxed in and configured */ 2372 /* First go to the default state */ 2373 if (!IS_ERR(pl022->pins_default)) { 2374 ret = pinctrl_select_state(pl022->pinctrl, pl022->pins_default); 2375 if (ret) 2376 dev_err(&pl022->adev->dev, 2377 "could not set default pins\n"); 2378 } 2379 2380 if (!runtime) { 2381 /* Then let's idle the pins until the next transfer happens */ 2382 if (!IS_ERR(pl022->pins_idle)) { 2383 ret = pinctrl_select_state(pl022->pinctrl, 2384 pl022->pins_idle); 2385 if (ret) 2386 dev_err(&pl022->adev->dev, 2387 "could not set idle pins\n"); 2388 } 2389 } 2390 2391 clk_enable(pl022->clk); 2392 } 2393 #endif 2394 2395 #ifdef CONFIG_SUSPEND 2396 static int pl022_suspend(struct device *dev) 2397 { 2398 struct pl022 *pl022 = dev_get_drvdata(dev); 2399 int ret; 2400 2401 ret = spi_master_suspend(pl022->master); 2402 if (ret) { 2403 dev_warn(dev, "cannot suspend master\n"); 2404 return ret; 2405 } 2406 2407 pm_runtime_get_sync(dev); 2408 pl022_suspend_resources(pl022, false); 2409 2410 dev_dbg(dev, "suspended\n"); 2411 return 0; 2412 } 2413 2414 static int pl022_resume(struct device *dev) 2415 { 2416 struct pl022 *pl022 = dev_get_drvdata(dev); 2417 int ret; 2418 2419 pl022_resume_resources(pl022, false); 2420 pm_runtime_put(dev); 2421 2422 /* Start the queue running */ 2423 ret = spi_master_resume(pl022->master); 2424 if (ret) 2425 dev_err(dev, "problem starting queue (%d)\n", ret); 2426 else 2427 dev_dbg(dev, "resumed\n"); 2428 2429 return ret; 2430 } 2431 #endif /* CONFIG_PM */ 2432 2433 #ifdef CONFIG_PM_RUNTIME 2434 static int pl022_runtime_suspend(struct device *dev) 2435 { 2436 struct pl022 *pl022 = dev_get_drvdata(dev); 2437 2438 pl022_suspend_resources(pl022, true); 2439 return 0; 2440 } 2441 2442 static int pl022_runtime_resume(struct device *dev) 2443 { 2444 struct pl022 *pl022 = dev_get_drvdata(dev); 2445 2446 pl022_resume_resources(pl022, true); 2447 return 0; 2448 } 2449 #endif 2450 2451 static const struct dev_pm_ops pl022_dev_pm_ops = { 2452 SET_SYSTEM_SLEEP_PM_OPS(pl022_suspend, pl022_resume) 2453 SET_RUNTIME_PM_OPS(pl022_runtime_suspend, pl022_runtime_resume, NULL) 2454 }; 2455 2456 static struct vendor_data vendor_arm = { 2457 .fifodepth = 8, 2458 .max_bpw = 16, 2459 .unidir = false, 2460 .extended_cr = false, 2461 .pl023 = false, 2462 .loopback = true, 2463 }; 2464 2465 static struct vendor_data vendor_st = { 2466 .fifodepth = 32, 2467 .max_bpw = 32, 2468 .unidir = false, 2469 .extended_cr = true, 2470 .pl023 = false, 2471 .loopback = true, 2472 }; 2473 2474 static struct vendor_data vendor_st_pl023 = { 2475 .fifodepth = 32, 2476 .max_bpw = 32, 2477 .unidir = false, 2478 .extended_cr = true, 2479 .pl023 = true, 2480 .loopback = false, 2481 }; 2482 2483 static struct amba_id pl022_ids[] = { 2484 { 2485 /* 2486 * ARM PL022 variant, this has a 16bit wide 2487 * and 8 locations deep TX/RX FIFO 2488 */ 2489 .id = 0x00041022, 2490 .mask = 0x000fffff, 2491 .data = &vendor_arm, 2492 }, 2493 { 2494 /* 2495 * ST Micro derivative, this has 32bit wide 2496 * and 32 locations deep TX/RX FIFO 2497 */ 2498 .id = 0x01080022, 2499 .mask = 0xffffffff, 2500 .data = &vendor_st, 2501 }, 2502 { 2503 /* 2504 * ST-Ericsson derivative "PL023" (this is not 2505 * an official ARM number), this is a PL022 SSP block 2506 * stripped to SPI mode only, it has 32bit wide 2507 * and 32 locations deep TX/RX FIFO but no extended 2508 * CR0/CR1 register 2509 */ 2510 .id = 0x00080023, 2511 .mask = 0xffffffff, 2512 .data = &vendor_st_pl023, 2513 }, 2514 { 0, 0 }, 2515 }; 2516 2517 MODULE_DEVICE_TABLE(amba, pl022_ids); 2518 2519 static struct amba_driver pl022_driver = { 2520 .drv = { 2521 .name = "ssp-pl022", 2522 .pm = &pl022_dev_pm_ops, 2523 }, 2524 .id_table = pl022_ids, 2525 .probe = pl022_probe, 2526 .remove = pl022_remove, 2527 }; 2528 2529 static int __init pl022_init(void) 2530 { 2531 return amba_driver_register(&pl022_driver); 2532 } 2533 subsys_initcall(pl022_init); 2534 2535 static void __exit pl022_exit(void) 2536 { 2537 amba_driver_unregister(&pl022_driver); 2538 } 2539 module_exit(pl022_exit); 2540 2541 MODULE_AUTHOR("Linus Walleij <linus.walleij@stericsson.com>"); 2542 MODULE_DESCRIPTION("PL022 SSP Controller Driver"); 2543 MODULE_LICENSE("GPL"); 2544