Linux Audio

Check our new training course

Embedded Linux training

Mar 10-20, 2025, special US time zones
Register
Loading...
v4.6
 
   1/*
   2 * au1550 psc spi controller driver
   3 * may work also with au1200, au1210, au1250
   4 * will not work on au1000, au1100 and au1500 (no full spi controller there)
   5 *
   6 * Copyright (c) 2006 ATRON electronic GmbH
   7 * Author: Jan Nikitenko <jan.nikitenko@gmail.com>
   8 *
   9 * This program is free software; you can redistribute it and/or modify
  10 * it under the terms of the GNU General Public License as published by
  11 * the Free Software Foundation; either version 2 of the License, or
  12 * (at your option) any later version.
  13 *
  14 * This program is distributed in the hope that it will be useful,
  15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17 * GNU General Public License for more details.
  18 */
  19
  20#include <linux/init.h>
  21#include <linux/interrupt.h>
  22#include <linux/slab.h>
  23#include <linux/errno.h>
  24#include <linux/module.h>
  25#include <linux/device.h>
  26#include <linux/platform_device.h>
  27#include <linux/resource.h>
  28#include <linux/spi/spi.h>
  29#include <linux/spi/spi_bitbang.h>
  30#include <linux/dma-mapping.h>
  31#include <linux/completion.h>
  32#include <asm/mach-au1x00/au1000.h>
  33#include <asm/mach-au1x00/au1xxx_psc.h>
  34#include <asm/mach-au1x00/au1xxx_dbdma.h>
  35
  36#include <asm/mach-au1x00/au1550_spi.h>
  37
  38static unsigned usedma = 1;
  39module_param(usedma, uint, 0644);
  40
  41/*
  42#define AU1550_SPI_DEBUG_LOOPBACK
  43*/
  44
  45
  46#define AU1550_SPI_DBDMA_DESCRIPTORS 1
  47#define AU1550_SPI_DMA_RXTMP_MINSIZE 2048U
  48
  49struct au1550_spi {
  50	struct spi_bitbang bitbang;
  51
  52	volatile psc_spi_t __iomem *regs;
  53	int irq;
  54
  55	unsigned len;
  56	unsigned tx_count;
  57	unsigned rx_count;
  58	const u8 *tx;
  59	u8 *rx;
  60
  61	void (*rx_word)(struct au1550_spi *hw);
  62	void (*tx_word)(struct au1550_spi *hw);
  63	int (*txrx_bufs)(struct spi_device *spi, struct spi_transfer *t);
  64	irqreturn_t (*irq_callback)(struct au1550_spi *hw);
  65
  66	struct completion master_done;
  67
  68	unsigned usedma;
  69	u32 dma_tx_id;
  70	u32 dma_rx_id;
  71	u32 dma_tx_ch;
  72	u32 dma_rx_ch;
  73
  74	u8 *dma_rx_tmpbuf;
  75	unsigned dma_rx_tmpbuf_size;
  76	u32 dma_rx_tmpbuf_addr;
  77
  78	struct spi_master *master;
  79	struct device *dev;
  80	struct au1550_spi_info *pdata;
  81	struct resource *ioarea;
  82};
  83
  84
  85/* we use an 8-bit memory device for dma transfers to/from spi fifo */
  86static dbdev_tab_t au1550_spi_mem_dbdev =
  87{
  88	.dev_id			= DBDMA_MEM_CHAN,
  89	.dev_flags		= DEV_FLAGS_ANYUSE|DEV_FLAGS_SYNC,
  90	.dev_tsize		= 0,
  91	.dev_devwidth		= 8,
  92	.dev_physaddr		= 0x00000000,
  93	.dev_intlevel		= 0,
  94	.dev_intpolarity	= 0
  95};
  96
  97static int ddma_memid;	/* id to above mem dma device */
  98
  99static void au1550_spi_bits_handlers_set(struct au1550_spi *hw, int bpw);
 100
 101
 102/*
 103 *  compute BRG and DIV bits to setup spi clock based on main input clock rate
 104 *  that was specified in platform data structure
 105 *  according to au1550 datasheet:
 106 *    psc_tempclk = psc_mainclk / (2 << DIV)
 107 *    spiclk = psc_tempclk / (2 * (BRG + 1))
 108 *    BRG valid range is 4..63
 109 *    DIV valid range is 0..3
 110 */
 111static u32 au1550_spi_baudcfg(struct au1550_spi *hw, unsigned speed_hz)
 112{
 113	u32 mainclk_hz = hw->pdata->mainclk_hz;
 114	u32 div, brg;
 115
 116	for (div = 0; div < 4; div++) {
 117		brg = mainclk_hz / speed_hz / (4 << div);
 118		/* now we have BRG+1 in brg, so count with that */
 119		if (brg < (4 + 1)) {
 120			brg = (4 + 1);	/* speed_hz too big */
 121			break;		/* set lowest brg (div is == 0) */
 122		}
 123		if (brg <= (63 + 1))
 124			break;		/* we have valid brg and div */
 125	}
 126	if (div == 4) {
 127		div = 3;		/* speed_hz too small */
 128		brg = (63 + 1);		/* set highest brg and div */
 129	}
 130	brg--;
 131	return PSC_SPICFG_SET_BAUD(brg) | PSC_SPICFG_SET_DIV(div);
 132}
 133
 134static inline void au1550_spi_mask_ack_all(struct au1550_spi *hw)
 135{
 136	hw->regs->psc_spimsk =
 137		  PSC_SPIMSK_MM | PSC_SPIMSK_RR | PSC_SPIMSK_RO
 138		| PSC_SPIMSK_RU | PSC_SPIMSK_TR | PSC_SPIMSK_TO
 139		| PSC_SPIMSK_TU | PSC_SPIMSK_SD | PSC_SPIMSK_MD;
 140	wmb(); /* drain writebuffer */
 141
 142	hw->regs->psc_spievent =
 143		  PSC_SPIEVNT_MM | PSC_SPIEVNT_RR | PSC_SPIEVNT_RO
 144		| PSC_SPIEVNT_RU | PSC_SPIEVNT_TR | PSC_SPIEVNT_TO
 145		| PSC_SPIEVNT_TU | PSC_SPIEVNT_SD | PSC_SPIEVNT_MD;
 146	wmb(); /* drain writebuffer */
 147}
 148
 149static void au1550_spi_reset_fifos(struct au1550_spi *hw)
 150{
 151	u32 pcr;
 152
 153	hw->regs->psc_spipcr = PSC_SPIPCR_RC | PSC_SPIPCR_TC;
 154	wmb(); /* drain writebuffer */
 155	do {
 156		pcr = hw->regs->psc_spipcr;
 157		wmb(); /* drain writebuffer */
 158	} while (pcr != 0);
 159}
 160
 161/*
 162 * dma transfers are used for the most common spi word size of 8-bits
 163 * we cannot easily change already set up dma channels' width, so if we wanted
 164 * dma support for more than 8-bit words (up to 24 bits), we would need to
 165 * setup dma channels from scratch on each spi transfer, based on bits_per_word
 166 * instead we have pre set up 8 bit dma channels supporting spi 4 to 8 bits
 167 * transfers, and 9 to 24 bits spi transfers will be done in pio irq based mode
 168 * callbacks to handle dma or pio are set up in au1550_spi_bits_handlers_set()
 169 */
 170static void au1550_spi_chipsel(struct spi_device *spi, int value)
 171{
 172	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
 173	unsigned cspol = spi->mode & SPI_CS_HIGH ? 1 : 0;
 174	u32 cfg, stat;
 175
 176	switch (value) {
 177	case BITBANG_CS_INACTIVE:
 178		if (hw->pdata->deactivate_cs)
 179			hw->pdata->deactivate_cs(hw->pdata, spi->chip_select,
 180					cspol);
 181		break;
 182
 183	case BITBANG_CS_ACTIVE:
 184		au1550_spi_bits_handlers_set(hw, spi->bits_per_word);
 185
 186		cfg = hw->regs->psc_spicfg;
 187		wmb(); /* drain writebuffer */
 188		hw->regs->psc_spicfg = cfg & ~PSC_SPICFG_DE_ENABLE;
 189		wmb(); /* drain writebuffer */
 190
 191		if (spi->mode & SPI_CPOL)
 192			cfg |= PSC_SPICFG_BI;
 193		else
 194			cfg &= ~PSC_SPICFG_BI;
 195		if (spi->mode & SPI_CPHA)
 196			cfg &= ~PSC_SPICFG_CDE;
 197		else
 198			cfg |= PSC_SPICFG_CDE;
 199
 200		if (spi->mode & SPI_LSB_FIRST)
 201			cfg |= PSC_SPICFG_MLF;
 202		else
 203			cfg &= ~PSC_SPICFG_MLF;
 204
 205		if (hw->usedma && spi->bits_per_word <= 8)
 206			cfg &= ~PSC_SPICFG_DD_DISABLE;
 207		else
 208			cfg |= PSC_SPICFG_DD_DISABLE;
 209		cfg = PSC_SPICFG_CLR_LEN(cfg);
 210		cfg |= PSC_SPICFG_SET_LEN(spi->bits_per_word);
 211
 212		cfg = PSC_SPICFG_CLR_BAUD(cfg);
 213		cfg &= ~PSC_SPICFG_SET_DIV(3);
 214		cfg |= au1550_spi_baudcfg(hw, spi->max_speed_hz);
 215
 216		hw->regs->psc_spicfg = cfg | PSC_SPICFG_DE_ENABLE;
 217		wmb(); /* drain writebuffer */
 218		do {
 219			stat = hw->regs->psc_spistat;
 220			wmb(); /* drain writebuffer */
 221		} while ((stat & PSC_SPISTAT_DR) == 0);
 222
 223		if (hw->pdata->activate_cs)
 224			hw->pdata->activate_cs(hw->pdata, spi->chip_select,
 225					cspol);
 226		break;
 227	}
 228}
 229
 230static int au1550_spi_setupxfer(struct spi_device *spi, struct spi_transfer *t)
 231{
 232	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
 233	unsigned bpw, hz;
 234	u32 cfg, stat;
 235
 236	if (t) {
 237		bpw = t->bits_per_word;
 238		hz = t->speed_hz;
 239	} else {
 240		bpw = spi->bits_per_word;
 241		hz = spi->max_speed_hz;
 242	}
 243
 244	if (!hz)
 245		return -EINVAL;
 246
 247	au1550_spi_bits_handlers_set(hw, spi->bits_per_word);
 248
 249	cfg = hw->regs->psc_spicfg;
 250	wmb(); /* drain writebuffer */
 251	hw->regs->psc_spicfg = cfg & ~PSC_SPICFG_DE_ENABLE;
 252	wmb(); /* drain writebuffer */
 253
 254	if (hw->usedma && bpw <= 8)
 255		cfg &= ~PSC_SPICFG_DD_DISABLE;
 256	else
 257		cfg |= PSC_SPICFG_DD_DISABLE;
 258	cfg = PSC_SPICFG_CLR_LEN(cfg);
 259	cfg |= PSC_SPICFG_SET_LEN(bpw);
 260
 261	cfg = PSC_SPICFG_CLR_BAUD(cfg);
 262	cfg &= ~PSC_SPICFG_SET_DIV(3);
 263	cfg |= au1550_spi_baudcfg(hw, hz);
 264
 265	hw->regs->psc_spicfg = cfg;
 266	wmb(); /* drain writebuffer */
 267
 268	if (cfg & PSC_SPICFG_DE_ENABLE) {
 269		do {
 270			stat = hw->regs->psc_spistat;
 271			wmb(); /* drain writebuffer */
 272		} while ((stat & PSC_SPISTAT_DR) == 0);
 273	}
 274
 275	au1550_spi_reset_fifos(hw);
 276	au1550_spi_mask_ack_all(hw);
 277	return 0;
 278}
 279
 280/*
 281 * for dma spi transfers, we have to setup rx channel, otherwise there is
 282 * no reliable way how to recognize that spi transfer is done
 283 * dma complete callbacks are called before real spi transfer is finished
 284 * and if only tx dma channel is set up (and rx fifo overflow event masked)
 285 * spi master done event irq is not generated unless rx fifo is empty (emptied)
 286 * so we need rx tmp buffer to use for rx dma if user does not provide one
 287 */
 288static int au1550_spi_dma_rxtmp_alloc(struct au1550_spi *hw, unsigned size)
 289{
 290	hw->dma_rx_tmpbuf = kmalloc(size, GFP_KERNEL);
 291	if (!hw->dma_rx_tmpbuf)
 292		return -ENOMEM;
 293	hw->dma_rx_tmpbuf_size = size;
 294	hw->dma_rx_tmpbuf_addr = dma_map_single(hw->dev, hw->dma_rx_tmpbuf,
 295			size, DMA_FROM_DEVICE);
 296	if (dma_mapping_error(hw->dev, hw->dma_rx_tmpbuf_addr)) {
 297		kfree(hw->dma_rx_tmpbuf);
 298		hw->dma_rx_tmpbuf = 0;
 299		hw->dma_rx_tmpbuf_size = 0;
 300		return -EFAULT;
 301	}
 302	return 0;
 303}
 304
 305static void au1550_spi_dma_rxtmp_free(struct au1550_spi *hw)
 306{
 307	dma_unmap_single(hw->dev, hw->dma_rx_tmpbuf_addr,
 308			hw->dma_rx_tmpbuf_size, DMA_FROM_DEVICE);
 309	kfree(hw->dma_rx_tmpbuf);
 310	hw->dma_rx_tmpbuf = 0;
 311	hw->dma_rx_tmpbuf_size = 0;
 312}
 313
 314static int au1550_spi_dma_txrxb(struct spi_device *spi, struct spi_transfer *t)
 315{
 316	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
 317	dma_addr_t dma_tx_addr;
 318	dma_addr_t dma_rx_addr;
 319	u32 res;
 320
 321	hw->len = t->len;
 322	hw->tx_count = 0;
 323	hw->rx_count = 0;
 324
 325	hw->tx = t->tx_buf;
 326	hw->rx = t->rx_buf;
 327	dma_tx_addr = t->tx_dma;
 328	dma_rx_addr = t->rx_dma;
 329
 330	/*
 331	 * check if buffers are already dma mapped, map them otherwise:
 332	 * - first map the TX buffer, so cache data gets written to memory
 333	 * - then map the RX buffer, so that cache entries (with
 334	 *   soon-to-be-stale data) get removed
 335	 * use rx buffer in place of tx if tx buffer was not provided
 336	 * use temp rx buffer (preallocated or realloc to fit) for rx dma
 337	 */
 338	if (t->tx_buf) {
 339		if (t->tx_dma == 0) {	/* if DMA_ADDR_INVALID, map it */
 340			dma_tx_addr = dma_map_single(hw->dev,
 341					(void *)t->tx_buf,
 342					t->len, DMA_TO_DEVICE);
 343			if (dma_mapping_error(hw->dev, dma_tx_addr))
 344				dev_err(hw->dev, "tx dma map error\n");
 345		}
 346	}
 347
 348	if (t->rx_buf) {
 349		if (t->rx_dma == 0) {	/* if DMA_ADDR_INVALID, map it */
 350			dma_rx_addr = dma_map_single(hw->dev,
 351					(void *)t->rx_buf,
 352					t->len, DMA_FROM_DEVICE);
 353			if (dma_mapping_error(hw->dev, dma_rx_addr))
 354				dev_err(hw->dev, "rx dma map error\n");
 355		}
 356	} else {
 357		if (t->len > hw->dma_rx_tmpbuf_size) {
 358			int ret;
 359
 360			au1550_spi_dma_rxtmp_free(hw);
 361			ret = au1550_spi_dma_rxtmp_alloc(hw, max(t->len,
 362					AU1550_SPI_DMA_RXTMP_MINSIZE));
 363			if (ret < 0)
 364				return ret;
 365		}
 366		hw->rx = hw->dma_rx_tmpbuf;
 367		dma_rx_addr = hw->dma_rx_tmpbuf_addr;
 368		dma_sync_single_for_device(hw->dev, dma_rx_addr,
 369			t->len, DMA_FROM_DEVICE);
 370	}
 371
 372	if (!t->tx_buf) {
 373		dma_sync_single_for_device(hw->dev, dma_rx_addr,
 374				t->len, DMA_BIDIRECTIONAL);
 375		hw->tx = hw->rx;
 376	}
 377
 378	/* put buffers on the ring */
 379	res = au1xxx_dbdma_put_dest(hw->dma_rx_ch, virt_to_phys(hw->rx),
 380				    t->len, DDMA_FLAGS_IE);
 381	if (!res)
 382		dev_err(hw->dev, "rx dma put dest error\n");
 383
 384	res = au1xxx_dbdma_put_source(hw->dma_tx_ch, virt_to_phys(hw->tx),
 385				      t->len, DDMA_FLAGS_IE);
 386	if (!res)
 387		dev_err(hw->dev, "tx dma put source error\n");
 388
 389	au1xxx_dbdma_start(hw->dma_rx_ch);
 390	au1xxx_dbdma_start(hw->dma_tx_ch);
 391
 392	/* by default enable nearly all events interrupt */
 393	hw->regs->psc_spimsk = PSC_SPIMSK_SD;
 394	wmb(); /* drain writebuffer */
 395
 396	/* start the transfer */
 397	hw->regs->psc_spipcr = PSC_SPIPCR_MS;
 398	wmb(); /* drain writebuffer */
 399
 400	wait_for_completion(&hw->master_done);
 401
 402	au1xxx_dbdma_stop(hw->dma_tx_ch);
 403	au1xxx_dbdma_stop(hw->dma_rx_ch);
 404
 405	if (!t->rx_buf) {
 406		/* using the temporal preallocated and premapped buffer */
 407		dma_sync_single_for_cpu(hw->dev, dma_rx_addr, t->len,
 408			DMA_FROM_DEVICE);
 409	}
 410	/* unmap buffers if mapped above */
 411	if (t->rx_buf && t->rx_dma == 0 )
 412		dma_unmap_single(hw->dev, dma_rx_addr, t->len,
 413			DMA_FROM_DEVICE);
 414	if (t->tx_buf && t->tx_dma == 0 )
 415		dma_unmap_single(hw->dev, dma_tx_addr, t->len,
 416			DMA_TO_DEVICE);
 417
 418	return hw->rx_count < hw->tx_count ? hw->rx_count : hw->tx_count;
 419}
 420
 421static irqreturn_t au1550_spi_dma_irq_callback(struct au1550_spi *hw)
 422{
 423	u32 stat, evnt;
 424
 425	stat = hw->regs->psc_spistat;
 426	evnt = hw->regs->psc_spievent;
 427	wmb(); /* drain writebuffer */
 428	if ((stat & PSC_SPISTAT_DI) == 0) {
 429		dev_err(hw->dev, "Unexpected IRQ!\n");
 430		return IRQ_NONE;
 431	}
 432
 433	if ((evnt & (PSC_SPIEVNT_MM | PSC_SPIEVNT_RO
 434				| PSC_SPIEVNT_RU | PSC_SPIEVNT_TO
 435				| PSC_SPIEVNT_TU | PSC_SPIEVNT_SD))
 436			!= 0) {
 437		/*
 438		 * due to an spi error we consider transfer as done,
 439		 * so mask all events until before next transfer start
 440		 * and stop the possibly running dma immediately
 441		 */
 442		au1550_spi_mask_ack_all(hw);
 443		au1xxx_dbdma_stop(hw->dma_rx_ch);
 444		au1xxx_dbdma_stop(hw->dma_tx_ch);
 445
 446		/* get number of transferred bytes */
 447		hw->rx_count = hw->len - au1xxx_get_dma_residue(hw->dma_rx_ch);
 448		hw->tx_count = hw->len - au1xxx_get_dma_residue(hw->dma_tx_ch);
 449
 450		au1xxx_dbdma_reset(hw->dma_rx_ch);
 451		au1xxx_dbdma_reset(hw->dma_tx_ch);
 452		au1550_spi_reset_fifos(hw);
 453
 454		if (evnt == PSC_SPIEVNT_RO)
 455			dev_err(hw->dev,
 456				"dma transfer: receive FIFO overflow!\n");
 457		else
 458			dev_err(hw->dev,
 459				"dma transfer: unexpected SPI error "
 460				"(event=0x%x stat=0x%x)!\n", evnt, stat);
 461
 462		complete(&hw->master_done);
 463		return IRQ_HANDLED;
 464	}
 465
 466	if ((evnt & PSC_SPIEVNT_MD) != 0) {
 467		/* transfer completed successfully */
 468		au1550_spi_mask_ack_all(hw);
 469		hw->rx_count = hw->len;
 470		hw->tx_count = hw->len;
 471		complete(&hw->master_done);
 472	}
 473	return IRQ_HANDLED;
 474}
 475
 476
 477/* routines to handle different word sizes in pio mode */
 478#define AU1550_SPI_RX_WORD(size, mask)					\
 479static void au1550_spi_rx_word_##size(struct au1550_spi *hw)		\
 480{									\
 481	u32 fifoword = hw->regs->psc_spitxrx & (u32)(mask);		\
 482	wmb(); /* drain writebuffer */					\
 483	if (hw->rx) {							\
 484		*(u##size *)hw->rx = (u##size)fifoword;			\
 485		hw->rx += (size) / 8;					\
 486	}								\
 487	hw->rx_count += (size) / 8;					\
 488}
 489
 490#define AU1550_SPI_TX_WORD(size, mask)					\
 491static void au1550_spi_tx_word_##size(struct au1550_spi *hw)		\
 492{									\
 493	u32 fifoword = 0;						\
 494	if (hw->tx) {							\
 495		fifoword = *(u##size *)hw->tx & (u32)(mask);		\
 496		hw->tx += (size) / 8;					\
 497	}								\
 498	hw->tx_count += (size) / 8;					\
 499	if (hw->tx_count >= hw->len)					\
 500		fifoword |= PSC_SPITXRX_LC;				\
 501	hw->regs->psc_spitxrx = fifoword;				\
 502	wmb(); /* drain writebuffer */					\
 503}
 504
 505AU1550_SPI_RX_WORD(8,0xff)
 506AU1550_SPI_RX_WORD(16,0xffff)
 507AU1550_SPI_RX_WORD(32,0xffffff)
 508AU1550_SPI_TX_WORD(8,0xff)
 509AU1550_SPI_TX_WORD(16,0xffff)
 510AU1550_SPI_TX_WORD(32,0xffffff)
 511
 512static int au1550_spi_pio_txrxb(struct spi_device *spi, struct spi_transfer *t)
 513{
 514	u32 stat, mask;
 515	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
 516
 517	hw->tx = t->tx_buf;
 518	hw->rx = t->rx_buf;
 519	hw->len = t->len;
 520	hw->tx_count = 0;
 521	hw->rx_count = 0;
 522
 523	/* by default enable nearly all events after filling tx fifo */
 524	mask = PSC_SPIMSK_SD;
 525
 526	/* fill the transmit FIFO */
 527	while (hw->tx_count < hw->len) {
 528
 529		hw->tx_word(hw);
 530
 531		if (hw->tx_count >= hw->len) {
 532			/* mask tx fifo request interrupt as we are done */
 533			mask |= PSC_SPIMSK_TR;
 534		}
 535
 536		stat = hw->regs->psc_spistat;
 537		wmb(); /* drain writebuffer */
 538		if (stat & PSC_SPISTAT_TF)
 539			break;
 540	}
 541
 542	/* enable event interrupts */
 543	hw->regs->psc_spimsk = mask;
 544	wmb(); /* drain writebuffer */
 545
 546	/* start the transfer */
 547	hw->regs->psc_spipcr = PSC_SPIPCR_MS;
 548	wmb(); /* drain writebuffer */
 549
 550	wait_for_completion(&hw->master_done);
 551
 552	return hw->rx_count < hw->tx_count ? hw->rx_count : hw->tx_count;
 553}
 554
 555static irqreturn_t au1550_spi_pio_irq_callback(struct au1550_spi *hw)
 556{
 557	int busy;
 558	u32 stat, evnt;
 559
 560	stat = hw->regs->psc_spistat;
 561	evnt = hw->regs->psc_spievent;
 562	wmb(); /* drain writebuffer */
 563	if ((stat & PSC_SPISTAT_DI) == 0) {
 564		dev_err(hw->dev, "Unexpected IRQ!\n");
 565		return IRQ_NONE;
 566	}
 567
 568	if ((evnt & (PSC_SPIEVNT_MM | PSC_SPIEVNT_RO
 569				| PSC_SPIEVNT_RU | PSC_SPIEVNT_TO
 570				| PSC_SPIEVNT_SD))
 571			!= 0) {
 572		/*
 573		 * due to an error we consider transfer as done,
 574		 * so mask all events until before next transfer start
 575		 */
 576		au1550_spi_mask_ack_all(hw);
 577		au1550_spi_reset_fifos(hw);
 578		dev_err(hw->dev,
 579			"pio transfer: unexpected SPI error "
 580			"(event=0x%x stat=0x%x)!\n", evnt, stat);
 581		complete(&hw->master_done);
 582		return IRQ_HANDLED;
 583	}
 584
 585	/*
 586	 * while there is something to read from rx fifo
 587	 * or there is a space to write to tx fifo:
 588	 */
 589	do {
 590		busy = 0;
 591		stat = hw->regs->psc_spistat;
 592		wmb(); /* drain writebuffer */
 593
 594		/*
 595		 * Take care to not let the Rx FIFO overflow.
 596		 *
 597		 * We only write a byte if we have read one at least. Initially,
 598		 * the write fifo is full, so we should read from the read fifo
 599		 * first.
 600		 * In case we miss a word from the read fifo, we should get a
 601		 * RO event and should back out.
 602		 */
 603		if (!(stat & PSC_SPISTAT_RE) && hw->rx_count < hw->len) {
 604			hw->rx_word(hw);
 605			busy = 1;
 606
 607			if (!(stat & PSC_SPISTAT_TF) && hw->tx_count < hw->len)
 608				hw->tx_word(hw);
 609		}
 610	} while (busy);
 611
 612	hw->regs->psc_spievent = PSC_SPIEVNT_RR | PSC_SPIEVNT_TR;
 613	wmb(); /* drain writebuffer */
 614
 615	/*
 616	 * Restart the SPI transmission in case of a transmit underflow.
 617	 * This seems to work despite the notes in the Au1550 data book
 618	 * of Figure 8-4 with flowchart for SPI master operation:
 619	 *
 620	 * """Note 1: An XFR Error Interrupt occurs, unless masked,
 621	 * for any of the following events: Tx FIFO Underflow,
 622	 * Rx FIFO Overflow, or Multiple-master Error
 623	 *    Note 2: In case of a Tx Underflow Error, all zeroes are
 624	 * transmitted."""
 625	 *
 626	 * By simply restarting the spi transfer on Tx Underflow Error,
 627	 * we assume that spi transfer was paused instead of zeroes
 628	 * transmittion mentioned in the Note 2 of Au1550 data book.
 629	 */
 630	if (evnt & PSC_SPIEVNT_TU) {
 631		hw->regs->psc_spievent = PSC_SPIEVNT_TU | PSC_SPIEVNT_MD;
 632		wmb(); /* drain writebuffer */
 633		hw->regs->psc_spipcr = PSC_SPIPCR_MS;
 634		wmb(); /* drain writebuffer */
 635	}
 636
 637	if (hw->rx_count >= hw->len) {
 638		/* transfer completed successfully */
 639		au1550_spi_mask_ack_all(hw);
 640		complete(&hw->master_done);
 641	}
 642	return IRQ_HANDLED;
 643}
 644
 645static int au1550_spi_txrx_bufs(struct spi_device *spi, struct spi_transfer *t)
 646{
 647	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
 648	return hw->txrx_bufs(spi, t);
 649}
 650
 651static irqreturn_t au1550_spi_irq(int irq, void *dev)
 652{
 653	struct au1550_spi *hw = dev;
 654	return hw->irq_callback(hw);
 655}
 656
 657static void au1550_spi_bits_handlers_set(struct au1550_spi *hw, int bpw)
 658{
 659	if (bpw <= 8) {
 660		if (hw->usedma) {
 661			hw->txrx_bufs = &au1550_spi_dma_txrxb;
 662			hw->irq_callback = &au1550_spi_dma_irq_callback;
 663		} else {
 664			hw->rx_word = &au1550_spi_rx_word_8;
 665			hw->tx_word = &au1550_spi_tx_word_8;
 666			hw->txrx_bufs = &au1550_spi_pio_txrxb;
 667			hw->irq_callback = &au1550_spi_pio_irq_callback;
 668		}
 669	} else if (bpw <= 16) {
 670		hw->rx_word = &au1550_spi_rx_word_16;
 671		hw->tx_word = &au1550_spi_tx_word_16;
 672		hw->txrx_bufs = &au1550_spi_pio_txrxb;
 673		hw->irq_callback = &au1550_spi_pio_irq_callback;
 674	} else {
 675		hw->rx_word = &au1550_spi_rx_word_32;
 676		hw->tx_word = &au1550_spi_tx_word_32;
 677		hw->txrx_bufs = &au1550_spi_pio_txrxb;
 678		hw->irq_callback = &au1550_spi_pio_irq_callback;
 679	}
 680}
 681
 682static void au1550_spi_setup_psc_as_spi(struct au1550_spi *hw)
 683{
 684	u32 stat, cfg;
 685
 686	/* set up the PSC for SPI mode */
 687	hw->regs->psc_ctrl = PSC_CTRL_DISABLE;
 688	wmb(); /* drain writebuffer */
 689	hw->regs->psc_sel = PSC_SEL_PS_SPIMODE;
 690	wmb(); /* drain writebuffer */
 691
 692	hw->regs->psc_spicfg = 0;
 693	wmb(); /* drain writebuffer */
 694
 695	hw->regs->psc_ctrl = PSC_CTRL_ENABLE;
 696	wmb(); /* drain writebuffer */
 697
 698	do {
 699		stat = hw->regs->psc_spistat;
 700		wmb(); /* drain writebuffer */
 701	} while ((stat & PSC_SPISTAT_SR) == 0);
 702
 703
 704	cfg = hw->usedma ? 0 : PSC_SPICFG_DD_DISABLE;
 705	cfg |= PSC_SPICFG_SET_LEN(8);
 706	cfg |= PSC_SPICFG_RT_FIFO8 | PSC_SPICFG_TT_FIFO8;
 707	/* use minimal allowed brg and div values as initial setting: */
 708	cfg |= PSC_SPICFG_SET_BAUD(4) | PSC_SPICFG_SET_DIV(0);
 709
 710#ifdef AU1550_SPI_DEBUG_LOOPBACK
 711	cfg |= PSC_SPICFG_LB;
 712#endif
 713
 714	hw->regs->psc_spicfg = cfg;
 715	wmb(); /* drain writebuffer */
 716
 717	au1550_spi_mask_ack_all(hw);
 718
 719	hw->regs->psc_spicfg |= PSC_SPICFG_DE_ENABLE;
 720	wmb(); /* drain writebuffer */
 721
 722	do {
 723		stat = hw->regs->psc_spistat;
 724		wmb(); /* drain writebuffer */
 725	} while ((stat & PSC_SPISTAT_DR) == 0);
 726
 727	au1550_spi_reset_fifos(hw);
 728}
 729
 730
 731static int au1550_spi_probe(struct platform_device *pdev)
 732{
 733	struct au1550_spi *hw;
 734	struct spi_master *master;
 735	struct resource *r;
 736	int err = 0;
 737
 738	master = spi_alloc_master(&pdev->dev, sizeof(struct au1550_spi));
 739	if (master == NULL) {
 740		dev_err(&pdev->dev, "No memory for spi_master\n");
 741		err = -ENOMEM;
 742		goto err_nomem;
 743	}
 744
 745	/* the spi->mode bits understood by this driver: */
 746	master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LSB_FIRST;
 747	master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 24);
 748
 749	hw = spi_master_get_devdata(master);
 750
 751	hw->master = master;
 752	hw->pdata = dev_get_platdata(&pdev->dev);
 753	hw->dev = &pdev->dev;
 754
 755	if (hw->pdata == NULL) {
 756		dev_err(&pdev->dev, "No platform data supplied\n");
 757		err = -ENOENT;
 758		goto err_no_pdata;
 759	}
 760
 761	r = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
 762	if (!r) {
 763		dev_err(&pdev->dev, "no IRQ\n");
 764		err = -ENODEV;
 765		goto err_no_iores;
 766	}
 767	hw->irq = r->start;
 768
 769	hw->usedma = 0;
 770	r = platform_get_resource(pdev, IORESOURCE_DMA, 0);
 771	if (r) {
 772		hw->dma_tx_id = r->start;
 773		r = platform_get_resource(pdev, IORESOURCE_DMA, 1);
 774		if (r) {
 775			hw->dma_rx_id = r->start;
 776			if (usedma && ddma_memid) {
 777				if (pdev->dev.dma_mask == NULL)
 778					dev_warn(&pdev->dev, "no dma mask\n");
 779				else
 780					hw->usedma = 1;
 781			}
 782		}
 783	}
 784
 785	r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 786	if (!r) {
 787		dev_err(&pdev->dev, "no mmio resource\n");
 788		err = -ENODEV;
 789		goto err_no_iores;
 790	}
 791
 792	hw->ioarea = request_mem_region(r->start, sizeof(psc_spi_t),
 793					pdev->name);
 794	if (!hw->ioarea) {
 795		dev_err(&pdev->dev, "Cannot reserve iomem region\n");
 796		err = -ENXIO;
 797		goto err_no_iores;
 798	}
 799
 800	hw->regs = (psc_spi_t __iomem *)ioremap(r->start, sizeof(psc_spi_t));
 801	if (!hw->regs) {
 802		dev_err(&pdev->dev, "cannot ioremap\n");
 803		err = -ENXIO;
 804		goto err_ioremap;
 805	}
 806
 807	platform_set_drvdata(pdev, hw);
 808
 809	init_completion(&hw->master_done);
 810
 811	hw->bitbang.master = hw->master;
 812	hw->bitbang.setup_transfer = au1550_spi_setupxfer;
 813	hw->bitbang.chipselect = au1550_spi_chipsel;
 814	hw->bitbang.txrx_bufs = au1550_spi_txrx_bufs;
 815
 816	if (hw->usedma) {
 817		hw->dma_tx_ch = au1xxx_dbdma_chan_alloc(ddma_memid,
 818			hw->dma_tx_id, NULL, (void *)hw);
 819		if (hw->dma_tx_ch == 0) {
 820			dev_err(&pdev->dev,
 821				"Cannot allocate tx dma channel\n");
 822			err = -ENXIO;
 823			goto err_no_txdma;
 824		}
 825		au1xxx_dbdma_set_devwidth(hw->dma_tx_ch, 8);
 826		if (au1xxx_dbdma_ring_alloc(hw->dma_tx_ch,
 827			AU1550_SPI_DBDMA_DESCRIPTORS) == 0) {
 828			dev_err(&pdev->dev,
 829				"Cannot allocate tx dma descriptors\n");
 830			err = -ENXIO;
 831			goto err_no_txdma_descr;
 832		}
 833
 834
 835		hw->dma_rx_ch = au1xxx_dbdma_chan_alloc(hw->dma_rx_id,
 836			ddma_memid, NULL, (void *)hw);
 837		if (hw->dma_rx_ch == 0) {
 838			dev_err(&pdev->dev,
 839				"Cannot allocate rx dma channel\n");
 840			err = -ENXIO;
 841			goto err_no_rxdma;
 842		}
 843		au1xxx_dbdma_set_devwidth(hw->dma_rx_ch, 8);
 844		if (au1xxx_dbdma_ring_alloc(hw->dma_rx_ch,
 845			AU1550_SPI_DBDMA_DESCRIPTORS) == 0) {
 846			dev_err(&pdev->dev,
 847				"Cannot allocate rx dma descriptors\n");
 848			err = -ENXIO;
 849			goto err_no_rxdma_descr;
 850		}
 851
 852		err = au1550_spi_dma_rxtmp_alloc(hw,
 853			AU1550_SPI_DMA_RXTMP_MINSIZE);
 854		if (err < 0) {
 855			dev_err(&pdev->dev,
 856				"Cannot allocate initial rx dma tmp buffer\n");
 857			goto err_dma_rxtmp_alloc;
 858		}
 859	}
 860
 861	au1550_spi_bits_handlers_set(hw, 8);
 862
 863	err = request_irq(hw->irq, au1550_spi_irq, 0, pdev->name, hw);
 864	if (err) {
 865		dev_err(&pdev->dev, "Cannot claim IRQ\n");
 866		goto err_no_irq;
 867	}
 868
 869	master->bus_num = pdev->id;
 870	master->num_chipselect = hw->pdata->num_chipselect;
 871
 872	/*
 873	 *  precompute valid range for spi freq - from au1550 datasheet:
 874	 *    psc_tempclk = psc_mainclk / (2 << DIV)
 875	 *    spiclk = psc_tempclk / (2 * (BRG + 1))
 876	 *    BRG valid range is 4..63
 877	 *    DIV valid range is 0..3
 878	 *  round the min and max frequencies to values that would still
 879	 *  produce valid brg and div
 880	 */
 881	{
 882		int min_div = (2 << 0) * (2 * (4 + 1));
 883		int max_div = (2 << 3) * (2 * (63 + 1));
 884		master->max_speed_hz = hw->pdata->mainclk_hz / min_div;
 885		master->min_speed_hz =
 886				hw->pdata->mainclk_hz / (max_div + 1) + 1;
 887	}
 888
 889	au1550_spi_setup_psc_as_spi(hw);
 890
 891	err = spi_bitbang_start(&hw->bitbang);
 892	if (err) {
 893		dev_err(&pdev->dev, "Failed to register SPI master\n");
 894		goto err_register;
 895	}
 896
 897	dev_info(&pdev->dev,
 898		"spi master registered: bus_num=%d num_chipselect=%d\n",
 899		master->bus_num, master->num_chipselect);
 900
 901	return 0;
 902
 903err_register:
 904	free_irq(hw->irq, hw);
 905
 906err_no_irq:
 907	au1550_spi_dma_rxtmp_free(hw);
 908
 909err_dma_rxtmp_alloc:
 910err_no_rxdma_descr:
 911	if (hw->usedma)
 912		au1xxx_dbdma_chan_free(hw->dma_rx_ch);
 913
 914err_no_rxdma:
 915err_no_txdma_descr:
 916	if (hw->usedma)
 917		au1xxx_dbdma_chan_free(hw->dma_tx_ch);
 918
 919err_no_txdma:
 920	iounmap((void __iomem *)hw->regs);
 921
 922err_ioremap:
 923	release_mem_region(r->start, sizeof(psc_spi_t));
 924
 925err_no_iores:
 926err_no_pdata:
 927	spi_master_put(hw->master);
 928
 929err_nomem:
 930	return err;
 931}
 932
 933static int au1550_spi_remove(struct platform_device *pdev)
 934{
 935	struct au1550_spi *hw = platform_get_drvdata(pdev);
 936
 937	dev_info(&pdev->dev, "spi master remove: bus_num=%d\n",
 938		hw->master->bus_num);
 939
 940	spi_bitbang_stop(&hw->bitbang);
 941	free_irq(hw->irq, hw);
 942	iounmap((void __iomem *)hw->regs);
 943	release_mem_region(hw->ioarea->start, sizeof(psc_spi_t));
 944
 945	if (hw->usedma) {
 946		au1550_spi_dma_rxtmp_free(hw);
 947		au1xxx_dbdma_chan_free(hw->dma_rx_ch);
 948		au1xxx_dbdma_chan_free(hw->dma_tx_ch);
 949	}
 950
 951	spi_master_put(hw->master);
 952	return 0;
 953}
 954
 955/* work with hotplug and coldplug */
 956MODULE_ALIAS("platform:au1550-spi");
 957
 958static struct platform_driver au1550_spi_drv = {
 959	.probe = au1550_spi_probe,
 960	.remove = au1550_spi_remove,
 961	.driver = {
 962		.name = "au1550-spi",
 963	},
 964};
 965
 966static int __init au1550_spi_init(void)
 967{
 968	/*
 969	 * create memory device with 8 bits dev_devwidth
 970	 * needed for proper byte ordering to spi fifo
 971	 */
 972	switch (alchemy_get_cputype()) {
 973	case ALCHEMY_CPU_AU1550:
 974	case ALCHEMY_CPU_AU1200:
 975	case ALCHEMY_CPU_AU1300:
 976		break;
 977	default:
 978		return -ENODEV;
 979	}
 980
 981	if (usedma) {
 982		ddma_memid = au1xxx_ddma_add_device(&au1550_spi_mem_dbdev);
 983		if (!ddma_memid)
 984			printk(KERN_ERR "au1550-spi: cannot add memory"
 985					"dbdma device\n");
 986	}
 987	return platform_driver_register(&au1550_spi_drv);
 988}
 989module_init(au1550_spi_init);
 990
 991static void __exit au1550_spi_exit(void)
 992{
 993	if (usedma && ddma_memid)
 994		au1xxx_ddma_del_device(ddma_memid);
 995	platform_driver_unregister(&au1550_spi_drv);
 996}
 997module_exit(au1550_spi_exit);
 998
 999MODULE_DESCRIPTION("Au1550 PSC SPI Driver");
1000MODULE_AUTHOR("Jan Nikitenko <jan.nikitenko@gmail.com>");
1001MODULE_LICENSE("GPL");
v5.4
  1// SPDX-License-Identifier: GPL-2.0-or-later
  2/*
  3 * au1550 psc spi controller driver
  4 * may work also with au1200, au1210, au1250
  5 * will not work on au1000, au1100 and au1500 (no full spi controller there)
  6 *
  7 * Copyright (c) 2006 ATRON electronic GmbH
  8 * Author: Jan Nikitenko <jan.nikitenko@gmail.com>
 
 
 
 
 
 
 
 
 
 
  9 */
 10
 11#include <linux/init.h>
 12#include <linux/interrupt.h>
 13#include <linux/slab.h>
 14#include <linux/errno.h>
 15#include <linux/module.h>
 16#include <linux/device.h>
 17#include <linux/platform_device.h>
 18#include <linux/resource.h>
 19#include <linux/spi/spi.h>
 20#include <linux/spi/spi_bitbang.h>
 21#include <linux/dma-mapping.h>
 22#include <linux/completion.h>
 23#include <asm/mach-au1x00/au1000.h>
 24#include <asm/mach-au1x00/au1xxx_psc.h>
 25#include <asm/mach-au1x00/au1xxx_dbdma.h>
 26
 27#include <asm/mach-au1x00/au1550_spi.h>
 28
 29static unsigned usedma = 1;
 30module_param(usedma, uint, 0644);
 31
 32/*
 33#define AU1550_SPI_DEBUG_LOOPBACK
 34*/
 35
 36
 37#define AU1550_SPI_DBDMA_DESCRIPTORS 1
 38#define AU1550_SPI_DMA_RXTMP_MINSIZE 2048U
 39
 40struct au1550_spi {
 41	struct spi_bitbang bitbang;
 42
 43	volatile psc_spi_t __iomem *regs;
 44	int irq;
 45
 46	unsigned len;
 47	unsigned tx_count;
 48	unsigned rx_count;
 49	const u8 *tx;
 50	u8 *rx;
 51
 52	void (*rx_word)(struct au1550_spi *hw);
 53	void (*tx_word)(struct au1550_spi *hw);
 54	int (*txrx_bufs)(struct spi_device *spi, struct spi_transfer *t);
 55	irqreturn_t (*irq_callback)(struct au1550_spi *hw);
 56
 57	struct completion master_done;
 58
 59	unsigned usedma;
 60	u32 dma_tx_id;
 61	u32 dma_rx_id;
 62	u32 dma_tx_ch;
 63	u32 dma_rx_ch;
 64
 65	u8 *dma_rx_tmpbuf;
 66	unsigned dma_rx_tmpbuf_size;
 67	u32 dma_rx_tmpbuf_addr;
 68
 69	struct spi_master *master;
 70	struct device *dev;
 71	struct au1550_spi_info *pdata;
 72	struct resource *ioarea;
 73};
 74
 75
 76/* we use an 8-bit memory device for dma transfers to/from spi fifo */
 77static dbdev_tab_t au1550_spi_mem_dbdev =
 78{
 79	.dev_id			= DBDMA_MEM_CHAN,
 80	.dev_flags		= DEV_FLAGS_ANYUSE|DEV_FLAGS_SYNC,
 81	.dev_tsize		= 0,
 82	.dev_devwidth		= 8,
 83	.dev_physaddr		= 0x00000000,
 84	.dev_intlevel		= 0,
 85	.dev_intpolarity	= 0
 86};
 87
 88static int ddma_memid;	/* id to above mem dma device */
 89
 90static void au1550_spi_bits_handlers_set(struct au1550_spi *hw, int bpw);
 91
 92
 93/*
 94 *  compute BRG and DIV bits to setup spi clock based on main input clock rate
 95 *  that was specified in platform data structure
 96 *  according to au1550 datasheet:
 97 *    psc_tempclk = psc_mainclk / (2 << DIV)
 98 *    spiclk = psc_tempclk / (2 * (BRG + 1))
 99 *    BRG valid range is 4..63
100 *    DIV valid range is 0..3
101 */
102static u32 au1550_spi_baudcfg(struct au1550_spi *hw, unsigned speed_hz)
103{
104	u32 mainclk_hz = hw->pdata->mainclk_hz;
105	u32 div, brg;
106
107	for (div = 0; div < 4; div++) {
108		brg = mainclk_hz / speed_hz / (4 << div);
109		/* now we have BRG+1 in brg, so count with that */
110		if (brg < (4 + 1)) {
111			brg = (4 + 1);	/* speed_hz too big */
112			break;		/* set lowest brg (div is == 0) */
113		}
114		if (brg <= (63 + 1))
115			break;		/* we have valid brg and div */
116	}
117	if (div == 4) {
118		div = 3;		/* speed_hz too small */
119		brg = (63 + 1);		/* set highest brg and div */
120	}
121	brg--;
122	return PSC_SPICFG_SET_BAUD(brg) | PSC_SPICFG_SET_DIV(div);
123}
124
125static inline void au1550_spi_mask_ack_all(struct au1550_spi *hw)
126{
127	hw->regs->psc_spimsk =
128		  PSC_SPIMSK_MM | PSC_SPIMSK_RR | PSC_SPIMSK_RO
129		| PSC_SPIMSK_RU | PSC_SPIMSK_TR | PSC_SPIMSK_TO
130		| PSC_SPIMSK_TU | PSC_SPIMSK_SD | PSC_SPIMSK_MD;
131	wmb(); /* drain writebuffer */
132
133	hw->regs->psc_spievent =
134		  PSC_SPIEVNT_MM | PSC_SPIEVNT_RR | PSC_SPIEVNT_RO
135		| PSC_SPIEVNT_RU | PSC_SPIEVNT_TR | PSC_SPIEVNT_TO
136		| PSC_SPIEVNT_TU | PSC_SPIEVNT_SD | PSC_SPIEVNT_MD;
137	wmb(); /* drain writebuffer */
138}
139
140static void au1550_spi_reset_fifos(struct au1550_spi *hw)
141{
142	u32 pcr;
143
144	hw->regs->psc_spipcr = PSC_SPIPCR_RC | PSC_SPIPCR_TC;
145	wmb(); /* drain writebuffer */
146	do {
147		pcr = hw->regs->psc_spipcr;
148		wmb(); /* drain writebuffer */
149	} while (pcr != 0);
150}
151
152/*
153 * dma transfers are used for the most common spi word size of 8-bits
154 * we cannot easily change already set up dma channels' width, so if we wanted
155 * dma support for more than 8-bit words (up to 24 bits), we would need to
156 * setup dma channels from scratch on each spi transfer, based on bits_per_word
157 * instead we have pre set up 8 bit dma channels supporting spi 4 to 8 bits
158 * transfers, and 9 to 24 bits spi transfers will be done in pio irq based mode
159 * callbacks to handle dma or pio are set up in au1550_spi_bits_handlers_set()
160 */
161static void au1550_spi_chipsel(struct spi_device *spi, int value)
162{
163	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
164	unsigned cspol = spi->mode & SPI_CS_HIGH ? 1 : 0;
165	u32 cfg, stat;
166
167	switch (value) {
168	case BITBANG_CS_INACTIVE:
169		if (hw->pdata->deactivate_cs)
170			hw->pdata->deactivate_cs(hw->pdata, spi->chip_select,
171					cspol);
172		break;
173
174	case BITBANG_CS_ACTIVE:
175		au1550_spi_bits_handlers_set(hw, spi->bits_per_word);
176
177		cfg = hw->regs->psc_spicfg;
178		wmb(); /* drain writebuffer */
179		hw->regs->psc_spicfg = cfg & ~PSC_SPICFG_DE_ENABLE;
180		wmb(); /* drain writebuffer */
181
182		if (spi->mode & SPI_CPOL)
183			cfg |= PSC_SPICFG_BI;
184		else
185			cfg &= ~PSC_SPICFG_BI;
186		if (spi->mode & SPI_CPHA)
187			cfg &= ~PSC_SPICFG_CDE;
188		else
189			cfg |= PSC_SPICFG_CDE;
190
191		if (spi->mode & SPI_LSB_FIRST)
192			cfg |= PSC_SPICFG_MLF;
193		else
194			cfg &= ~PSC_SPICFG_MLF;
195
196		if (hw->usedma && spi->bits_per_word <= 8)
197			cfg &= ~PSC_SPICFG_DD_DISABLE;
198		else
199			cfg |= PSC_SPICFG_DD_DISABLE;
200		cfg = PSC_SPICFG_CLR_LEN(cfg);
201		cfg |= PSC_SPICFG_SET_LEN(spi->bits_per_word);
202
203		cfg = PSC_SPICFG_CLR_BAUD(cfg);
204		cfg &= ~PSC_SPICFG_SET_DIV(3);
205		cfg |= au1550_spi_baudcfg(hw, spi->max_speed_hz);
206
207		hw->regs->psc_spicfg = cfg | PSC_SPICFG_DE_ENABLE;
208		wmb(); /* drain writebuffer */
209		do {
210			stat = hw->regs->psc_spistat;
211			wmb(); /* drain writebuffer */
212		} while ((stat & PSC_SPISTAT_DR) == 0);
213
214		if (hw->pdata->activate_cs)
215			hw->pdata->activate_cs(hw->pdata, spi->chip_select,
216					cspol);
217		break;
218	}
219}
220
221static int au1550_spi_setupxfer(struct spi_device *spi, struct spi_transfer *t)
222{
223	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
224	unsigned bpw, hz;
225	u32 cfg, stat;
226
227	if (t) {
228		bpw = t->bits_per_word;
229		hz = t->speed_hz;
230	} else {
231		bpw = spi->bits_per_word;
232		hz = spi->max_speed_hz;
233	}
234
235	if (!hz)
236		return -EINVAL;
237
238	au1550_spi_bits_handlers_set(hw, spi->bits_per_word);
239
240	cfg = hw->regs->psc_spicfg;
241	wmb(); /* drain writebuffer */
242	hw->regs->psc_spicfg = cfg & ~PSC_SPICFG_DE_ENABLE;
243	wmb(); /* drain writebuffer */
244
245	if (hw->usedma && bpw <= 8)
246		cfg &= ~PSC_SPICFG_DD_DISABLE;
247	else
248		cfg |= PSC_SPICFG_DD_DISABLE;
249	cfg = PSC_SPICFG_CLR_LEN(cfg);
250	cfg |= PSC_SPICFG_SET_LEN(bpw);
251
252	cfg = PSC_SPICFG_CLR_BAUD(cfg);
253	cfg &= ~PSC_SPICFG_SET_DIV(3);
254	cfg |= au1550_spi_baudcfg(hw, hz);
255
256	hw->regs->psc_spicfg = cfg;
257	wmb(); /* drain writebuffer */
258
259	if (cfg & PSC_SPICFG_DE_ENABLE) {
260		do {
261			stat = hw->regs->psc_spistat;
262			wmb(); /* drain writebuffer */
263		} while ((stat & PSC_SPISTAT_DR) == 0);
264	}
265
266	au1550_spi_reset_fifos(hw);
267	au1550_spi_mask_ack_all(hw);
268	return 0;
269}
270
271/*
272 * for dma spi transfers, we have to setup rx channel, otherwise there is
273 * no reliable way how to recognize that spi transfer is done
274 * dma complete callbacks are called before real spi transfer is finished
275 * and if only tx dma channel is set up (and rx fifo overflow event masked)
276 * spi master done event irq is not generated unless rx fifo is empty (emptied)
277 * so we need rx tmp buffer to use for rx dma if user does not provide one
278 */
279static int au1550_spi_dma_rxtmp_alloc(struct au1550_spi *hw, unsigned size)
280{
281	hw->dma_rx_tmpbuf = kmalloc(size, GFP_KERNEL);
282	if (!hw->dma_rx_tmpbuf)
283		return -ENOMEM;
284	hw->dma_rx_tmpbuf_size = size;
285	hw->dma_rx_tmpbuf_addr = dma_map_single(hw->dev, hw->dma_rx_tmpbuf,
286			size, DMA_FROM_DEVICE);
287	if (dma_mapping_error(hw->dev, hw->dma_rx_tmpbuf_addr)) {
288		kfree(hw->dma_rx_tmpbuf);
289		hw->dma_rx_tmpbuf = 0;
290		hw->dma_rx_tmpbuf_size = 0;
291		return -EFAULT;
292	}
293	return 0;
294}
295
296static void au1550_spi_dma_rxtmp_free(struct au1550_spi *hw)
297{
298	dma_unmap_single(hw->dev, hw->dma_rx_tmpbuf_addr,
299			hw->dma_rx_tmpbuf_size, DMA_FROM_DEVICE);
300	kfree(hw->dma_rx_tmpbuf);
301	hw->dma_rx_tmpbuf = 0;
302	hw->dma_rx_tmpbuf_size = 0;
303}
304
305static int au1550_spi_dma_txrxb(struct spi_device *spi, struct spi_transfer *t)
306{
307	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
308	dma_addr_t dma_tx_addr;
309	dma_addr_t dma_rx_addr;
310	u32 res;
311
312	hw->len = t->len;
313	hw->tx_count = 0;
314	hw->rx_count = 0;
315
316	hw->tx = t->tx_buf;
317	hw->rx = t->rx_buf;
318	dma_tx_addr = t->tx_dma;
319	dma_rx_addr = t->rx_dma;
320
321	/*
322	 * check if buffers are already dma mapped, map them otherwise:
323	 * - first map the TX buffer, so cache data gets written to memory
324	 * - then map the RX buffer, so that cache entries (with
325	 *   soon-to-be-stale data) get removed
326	 * use rx buffer in place of tx if tx buffer was not provided
327	 * use temp rx buffer (preallocated or realloc to fit) for rx dma
328	 */
329	if (t->tx_buf) {
330		if (t->tx_dma == 0) {	/* if DMA_ADDR_INVALID, map it */
331			dma_tx_addr = dma_map_single(hw->dev,
332					(void *)t->tx_buf,
333					t->len, DMA_TO_DEVICE);
334			if (dma_mapping_error(hw->dev, dma_tx_addr))
335				dev_err(hw->dev, "tx dma map error\n");
336		}
337	}
338
339	if (t->rx_buf) {
340		if (t->rx_dma == 0) {	/* if DMA_ADDR_INVALID, map it */
341			dma_rx_addr = dma_map_single(hw->dev,
342					(void *)t->rx_buf,
343					t->len, DMA_FROM_DEVICE);
344			if (dma_mapping_error(hw->dev, dma_rx_addr))
345				dev_err(hw->dev, "rx dma map error\n");
346		}
347	} else {
348		if (t->len > hw->dma_rx_tmpbuf_size) {
349			int ret;
350
351			au1550_spi_dma_rxtmp_free(hw);
352			ret = au1550_spi_dma_rxtmp_alloc(hw, max(t->len,
353					AU1550_SPI_DMA_RXTMP_MINSIZE));
354			if (ret < 0)
355				return ret;
356		}
357		hw->rx = hw->dma_rx_tmpbuf;
358		dma_rx_addr = hw->dma_rx_tmpbuf_addr;
359		dma_sync_single_for_device(hw->dev, dma_rx_addr,
360			t->len, DMA_FROM_DEVICE);
361	}
362
363	if (!t->tx_buf) {
364		dma_sync_single_for_device(hw->dev, dma_rx_addr,
365				t->len, DMA_BIDIRECTIONAL);
366		hw->tx = hw->rx;
367	}
368
369	/* put buffers on the ring */
370	res = au1xxx_dbdma_put_dest(hw->dma_rx_ch, virt_to_phys(hw->rx),
371				    t->len, DDMA_FLAGS_IE);
372	if (!res)
373		dev_err(hw->dev, "rx dma put dest error\n");
374
375	res = au1xxx_dbdma_put_source(hw->dma_tx_ch, virt_to_phys(hw->tx),
376				      t->len, DDMA_FLAGS_IE);
377	if (!res)
378		dev_err(hw->dev, "tx dma put source error\n");
379
380	au1xxx_dbdma_start(hw->dma_rx_ch);
381	au1xxx_dbdma_start(hw->dma_tx_ch);
382
383	/* by default enable nearly all events interrupt */
384	hw->regs->psc_spimsk = PSC_SPIMSK_SD;
385	wmb(); /* drain writebuffer */
386
387	/* start the transfer */
388	hw->regs->psc_spipcr = PSC_SPIPCR_MS;
389	wmb(); /* drain writebuffer */
390
391	wait_for_completion(&hw->master_done);
392
393	au1xxx_dbdma_stop(hw->dma_tx_ch);
394	au1xxx_dbdma_stop(hw->dma_rx_ch);
395
396	if (!t->rx_buf) {
397		/* using the temporal preallocated and premapped buffer */
398		dma_sync_single_for_cpu(hw->dev, dma_rx_addr, t->len,
399			DMA_FROM_DEVICE);
400	}
401	/* unmap buffers if mapped above */
402	if (t->rx_buf && t->rx_dma == 0 )
403		dma_unmap_single(hw->dev, dma_rx_addr, t->len,
404			DMA_FROM_DEVICE);
405	if (t->tx_buf && t->tx_dma == 0 )
406		dma_unmap_single(hw->dev, dma_tx_addr, t->len,
407			DMA_TO_DEVICE);
408
409	return hw->rx_count < hw->tx_count ? hw->rx_count : hw->tx_count;
410}
411
412static irqreturn_t au1550_spi_dma_irq_callback(struct au1550_spi *hw)
413{
414	u32 stat, evnt;
415
416	stat = hw->regs->psc_spistat;
417	evnt = hw->regs->psc_spievent;
418	wmb(); /* drain writebuffer */
419	if ((stat & PSC_SPISTAT_DI) == 0) {
420		dev_err(hw->dev, "Unexpected IRQ!\n");
421		return IRQ_NONE;
422	}
423
424	if ((evnt & (PSC_SPIEVNT_MM | PSC_SPIEVNT_RO
425				| PSC_SPIEVNT_RU | PSC_SPIEVNT_TO
426				| PSC_SPIEVNT_TU | PSC_SPIEVNT_SD))
427			!= 0) {
428		/*
429		 * due to an spi error we consider transfer as done,
430		 * so mask all events until before next transfer start
431		 * and stop the possibly running dma immediately
432		 */
433		au1550_spi_mask_ack_all(hw);
434		au1xxx_dbdma_stop(hw->dma_rx_ch);
435		au1xxx_dbdma_stop(hw->dma_tx_ch);
436
437		/* get number of transferred bytes */
438		hw->rx_count = hw->len - au1xxx_get_dma_residue(hw->dma_rx_ch);
439		hw->tx_count = hw->len - au1xxx_get_dma_residue(hw->dma_tx_ch);
440
441		au1xxx_dbdma_reset(hw->dma_rx_ch);
442		au1xxx_dbdma_reset(hw->dma_tx_ch);
443		au1550_spi_reset_fifos(hw);
444
445		if (evnt == PSC_SPIEVNT_RO)
446			dev_err(hw->dev,
447				"dma transfer: receive FIFO overflow!\n");
448		else
449			dev_err(hw->dev,
450				"dma transfer: unexpected SPI error "
451				"(event=0x%x stat=0x%x)!\n", evnt, stat);
452
453		complete(&hw->master_done);
454		return IRQ_HANDLED;
455	}
456
457	if ((evnt & PSC_SPIEVNT_MD) != 0) {
458		/* transfer completed successfully */
459		au1550_spi_mask_ack_all(hw);
460		hw->rx_count = hw->len;
461		hw->tx_count = hw->len;
462		complete(&hw->master_done);
463	}
464	return IRQ_HANDLED;
465}
466
467
468/* routines to handle different word sizes in pio mode */
469#define AU1550_SPI_RX_WORD(size, mask)					\
470static void au1550_spi_rx_word_##size(struct au1550_spi *hw)		\
471{									\
472	u32 fifoword = hw->regs->psc_spitxrx & (u32)(mask);		\
473	wmb(); /* drain writebuffer */					\
474	if (hw->rx) {							\
475		*(u##size *)hw->rx = (u##size)fifoword;			\
476		hw->rx += (size) / 8;					\
477	}								\
478	hw->rx_count += (size) / 8;					\
479}
480
481#define AU1550_SPI_TX_WORD(size, mask)					\
482static void au1550_spi_tx_word_##size(struct au1550_spi *hw)		\
483{									\
484	u32 fifoword = 0;						\
485	if (hw->tx) {							\
486		fifoword = *(u##size *)hw->tx & (u32)(mask);		\
487		hw->tx += (size) / 8;					\
488	}								\
489	hw->tx_count += (size) / 8;					\
490	if (hw->tx_count >= hw->len)					\
491		fifoword |= PSC_SPITXRX_LC;				\
492	hw->regs->psc_spitxrx = fifoword;				\
493	wmb(); /* drain writebuffer */					\
494}
495
496AU1550_SPI_RX_WORD(8,0xff)
497AU1550_SPI_RX_WORD(16,0xffff)
498AU1550_SPI_RX_WORD(32,0xffffff)
499AU1550_SPI_TX_WORD(8,0xff)
500AU1550_SPI_TX_WORD(16,0xffff)
501AU1550_SPI_TX_WORD(32,0xffffff)
502
503static int au1550_spi_pio_txrxb(struct spi_device *spi, struct spi_transfer *t)
504{
505	u32 stat, mask;
506	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
507
508	hw->tx = t->tx_buf;
509	hw->rx = t->rx_buf;
510	hw->len = t->len;
511	hw->tx_count = 0;
512	hw->rx_count = 0;
513
514	/* by default enable nearly all events after filling tx fifo */
515	mask = PSC_SPIMSK_SD;
516
517	/* fill the transmit FIFO */
518	while (hw->tx_count < hw->len) {
519
520		hw->tx_word(hw);
521
522		if (hw->tx_count >= hw->len) {
523			/* mask tx fifo request interrupt as we are done */
524			mask |= PSC_SPIMSK_TR;
525		}
526
527		stat = hw->regs->psc_spistat;
528		wmb(); /* drain writebuffer */
529		if (stat & PSC_SPISTAT_TF)
530			break;
531	}
532
533	/* enable event interrupts */
534	hw->regs->psc_spimsk = mask;
535	wmb(); /* drain writebuffer */
536
537	/* start the transfer */
538	hw->regs->psc_spipcr = PSC_SPIPCR_MS;
539	wmb(); /* drain writebuffer */
540
541	wait_for_completion(&hw->master_done);
542
543	return hw->rx_count < hw->tx_count ? hw->rx_count : hw->tx_count;
544}
545
546static irqreturn_t au1550_spi_pio_irq_callback(struct au1550_spi *hw)
547{
548	int busy;
549	u32 stat, evnt;
550
551	stat = hw->regs->psc_spistat;
552	evnt = hw->regs->psc_spievent;
553	wmb(); /* drain writebuffer */
554	if ((stat & PSC_SPISTAT_DI) == 0) {
555		dev_err(hw->dev, "Unexpected IRQ!\n");
556		return IRQ_NONE;
557	}
558
559	if ((evnt & (PSC_SPIEVNT_MM | PSC_SPIEVNT_RO
560				| PSC_SPIEVNT_RU | PSC_SPIEVNT_TO
561				| PSC_SPIEVNT_SD))
562			!= 0) {
563		/*
564		 * due to an error we consider transfer as done,
565		 * so mask all events until before next transfer start
566		 */
567		au1550_spi_mask_ack_all(hw);
568		au1550_spi_reset_fifos(hw);
569		dev_err(hw->dev,
570			"pio transfer: unexpected SPI error "
571			"(event=0x%x stat=0x%x)!\n", evnt, stat);
572		complete(&hw->master_done);
573		return IRQ_HANDLED;
574	}
575
576	/*
577	 * while there is something to read from rx fifo
578	 * or there is a space to write to tx fifo:
579	 */
580	do {
581		busy = 0;
582		stat = hw->regs->psc_spistat;
583		wmb(); /* drain writebuffer */
584
585		/*
586		 * Take care to not let the Rx FIFO overflow.
587		 *
588		 * We only write a byte if we have read one at least. Initially,
589		 * the write fifo is full, so we should read from the read fifo
590		 * first.
591		 * In case we miss a word from the read fifo, we should get a
592		 * RO event and should back out.
593		 */
594		if (!(stat & PSC_SPISTAT_RE) && hw->rx_count < hw->len) {
595			hw->rx_word(hw);
596			busy = 1;
597
598			if (!(stat & PSC_SPISTAT_TF) && hw->tx_count < hw->len)
599				hw->tx_word(hw);
600		}
601	} while (busy);
602
603	hw->regs->psc_spievent = PSC_SPIEVNT_RR | PSC_SPIEVNT_TR;
604	wmb(); /* drain writebuffer */
605
606	/*
607	 * Restart the SPI transmission in case of a transmit underflow.
608	 * This seems to work despite the notes in the Au1550 data book
609	 * of Figure 8-4 with flowchart for SPI master operation:
610	 *
611	 * """Note 1: An XFR Error Interrupt occurs, unless masked,
612	 * for any of the following events: Tx FIFO Underflow,
613	 * Rx FIFO Overflow, or Multiple-master Error
614	 *    Note 2: In case of a Tx Underflow Error, all zeroes are
615	 * transmitted."""
616	 *
617	 * By simply restarting the spi transfer on Tx Underflow Error,
618	 * we assume that spi transfer was paused instead of zeroes
619	 * transmittion mentioned in the Note 2 of Au1550 data book.
620	 */
621	if (evnt & PSC_SPIEVNT_TU) {
622		hw->regs->psc_spievent = PSC_SPIEVNT_TU | PSC_SPIEVNT_MD;
623		wmb(); /* drain writebuffer */
624		hw->regs->psc_spipcr = PSC_SPIPCR_MS;
625		wmb(); /* drain writebuffer */
626	}
627
628	if (hw->rx_count >= hw->len) {
629		/* transfer completed successfully */
630		au1550_spi_mask_ack_all(hw);
631		complete(&hw->master_done);
632	}
633	return IRQ_HANDLED;
634}
635
636static int au1550_spi_txrx_bufs(struct spi_device *spi, struct spi_transfer *t)
637{
638	struct au1550_spi *hw = spi_master_get_devdata(spi->master);
639	return hw->txrx_bufs(spi, t);
640}
641
642static irqreturn_t au1550_spi_irq(int irq, void *dev)
643{
644	struct au1550_spi *hw = dev;
645	return hw->irq_callback(hw);
646}
647
648static void au1550_spi_bits_handlers_set(struct au1550_spi *hw, int bpw)
649{
650	if (bpw <= 8) {
651		if (hw->usedma) {
652			hw->txrx_bufs = &au1550_spi_dma_txrxb;
653			hw->irq_callback = &au1550_spi_dma_irq_callback;
654		} else {
655			hw->rx_word = &au1550_spi_rx_word_8;
656			hw->tx_word = &au1550_spi_tx_word_8;
657			hw->txrx_bufs = &au1550_spi_pio_txrxb;
658			hw->irq_callback = &au1550_spi_pio_irq_callback;
659		}
660	} else if (bpw <= 16) {
661		hw->rx_word = &au1550_spi_rx_word_16;
662		hw->tx_word = &au1550_spi_tx_word_16;
663		hw->txrx_bufs = &au1550_spi_pio_txrxb;
664		hw->irq_callback = &au1550_spi_pio_irq_callback;
665	} else {
666		hw->rx_word = &au1550_spi_rx_word_32;
667		hw->tx_word = &au1550_spi_tx_word_32;
668		hw->txrx_bufs = &au1550_spi_pio_txrxb;
669		hw->irq_callback = &au1550_spi_pio_irq_callback;
670	}
671}
672
673static void au1550_spi_setup_psc_as_spi(struct au1550_spi *hw)
674{
675	u32 stat, cfg;
676
677	/* set up the PSC for SPI mode */
678	hw->regs->psc_ctrl = PSC_CTRL_DISABLE;
679	wmb(); /* drain writebuffer */
680	hw->regs->psc_sel = PSC_SEL_PS_SPIMODE;
681	wmb(); /* drain writebuffer */
682
683	hw->regs->psc_spicfg = 0;
684	wmb(); /* drain writebuffer */
685
686	hw->regs->psc_ctrl = PSC_CTRL_ENABLE;
687	wmb(); /* drain writebuffer */
688
689	do {
690		stat = hw->regs->psc_spistat;
691		wmb(); /* drain writebuffer */
692	} while ((stat & PSC_SPISTAT_SR) == 0);
693
694
695	cfg = hw->usedma ? 0 : PSC_SPICFG_DD_DISABLE;
696	cfg |= PSC_SPICFG_SET_LEN(8);
697	cfg |= PSC_SPICFG_RT_FIFO8 | PSC_SPICFG_TT_FIFO8;
698	/* use minimal allowed brg and div values as initial setting: */
699	cfg |= PSC_SPICFG_SET_BAUD(4) | PSC_SPICFG_SET_DIV(0);
700
701#ifdef AU1550_SPI_DEBUG_LOOPBACK
702	cfg |= PSC_SPICFG_LB;
703#endif
704
705	hw->regs->psc_spicfg = cfg;
706	wmb(); /* drain writebuffer */
707
708	au1550_spi_mask_ack_all(hw);
709
710	hw->regs->psc_spicfg |= PSC_SPICFG_DE_ENABLE;
711	wmb(); /* drain writebuffer */
712
713	do {
714		stat = hw->regs->psc_spistat;
715		wmb(); /* drain writebuffer */
716	} while ((stat & PSC_SPISTAT_DR) == 0);
717
718	au1550_spi_reset_fifos(hw);
719}
720
721
722static int au1550_spi_probe(struct platform_device *pdev)
723{
724	struct au1550_spi *hw;
725	struct spi_master *master;
726	struct resource *r;
727	int err = 0;
728
729	master = spi_alloc_master(&pdev->dev, sizeof(struct au1550_spi));
730	if (master == NULL) {
731		dev_err(&pdev->dev, "No memory for spi_master\n");
732		err = -ENOMEM;
733		goto err_nomem;
734	}
735
736	/* the spi->mode bits understood by this driver: */
737	master->mode_bits = SPI_CPOL | SPI_CPHA | SPI_CS_HIGH | SPI_LSB_FIRST;
738	master->bits_per_word_mask = SPI_BPW_RANGE_MASK(4, 24);
739
740	hw = spi_master_get_devdata(master);
741
742	hw->master = master;
743	hw->pdata = dev_get_platdata(&pdev->dev);
744	hw->dev = &pdev->dev;
745
746	if (hw->pdata == NULL) {
747		dev_err(&pdev->dev, "No platform data supplied\n");
748		err = -ENOENT;
749		goto err_no_pdata;
750	}
751
752	r = platform_get_resource(pdev, IORESOURCE_IRQ, 0);
753	if (!r) {
754		dev_err(&pdev->dev, "no IRQ\n");
755		err = -ENODEV;
756		goto err_no_iores;
757	}
758	hw->irq = r->start;
759
760	hw->usedma = 0;
761	r = platform_get_resource(pdev, IORESOURCE_DMA, 0);
762	if (r) {
763		hw->dma_tx_id = r->start;
764		r = platform_get_resource(pdev, IORESOURCE_DMA, 1);
765		if (r) {
766			hw->dma_rx_id = r->start;
767			if (usedma && ddma_memid) {
768				if (pdev->dev.dma_mask == NULL)
769					dev_warn(&pdev->dev, "no dma mask\n");
770				else
771					hw->usedma = 1;
772			}
773		}
774	}
775
776	r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
777	if (!r) {
778		dev_err(&pdev->dev, "no mmio resource\n");
779		err = -ENODEV;
780		goto err_no_iores;
781	}
782
783	hw->ioarea = request_mem_region(r->start, sizeof(psc_spi_t),
784					pdev->name);
785	if (!hw->ioarea) {
786		dev_err(&pdev->dev, "Cannot reserve iomem region\n");
787		err = -ENXIO;
788		goto err_no_iores;
789	}
790
791	hw->regs = (psc_spi_t __iomem *)ioremap(r->start, sizeof(psc_spi_t));
792	if (!hw->regs) {
793		dev_err(&pdev->dev, "cannot ioremap\n");
794		err = -ENXIO;
795		goto err_ioremap;
796	}
797
798	platform_set_drvdata(pdev, hw);
799
800	init_completion(&hw->master_done);
801
802	hw->bitbang.master = hw->master;
803	hw->bitbang.setup_transfer = au1550_spi_setupxfer;
804	hw->bitbang.chipselect = au1550_spi_chipsel;
805	hw->bitbang.txrx_bufs = au1550_spi_txrx_bufs;
806
807	if (hw->usedma) {
808		hw->dma_tx_ch = au1xxx_dbdma_chan_alloc(ddma_memid,
809			hw->dma_tx_id, NULL, (void *)hw);
810		if (hw->dma_tx_ch == 0) {
811			dev_err(&pdev->dev,
812				"Cannot allocate tx dma channel\n");
813			err = -ENXIO;
814			goto err_no_txdma;
815		}
816		au1xxx_dbdma_set_devwidth(hw->dma_tx_ch, 8);
817		if (au1xxx_dbdma_ring_alloc(hw->dma_tx_ch,
818			AU1550_SPI_DBDMA_DESCRIPTORS) == 0) {
819			dev_err(&pdev->dev,
820				"Cannot allocate tx dma descriptors\n");
821			err = -ENXIO;
822			goto err_no_txdma_descr;
823		}
824
825
826		hw->dma_rx_ch = au1xxx_dbdma_chan_alloc(hw->dma_rx_id,
827			ddma_memid, NULL, (void *)hw);
828		if (hw->dma_rx_ch == 0) {
829			dev_err(&pdev->dev,
830				"Cannot allocate rx dma channel\n");
831			err = -ENXIO;
832			goto err_no_rxdma;
833		}
834		au1xxx_dbdma_set_devwidth(hw->dma_rx_ch, 8);
835		if (au1xxx_dbdma_ring_alloc(hw->dma_rx_ch,
836			AU1550_SPI_DBDMA_DESCRIPTORS) == 0) {
837			dev_err(&pdev->dev,
838				"Cannot allocate rx dma descriptors\n");
839			err = -ENXIO;
840			goto err_no_rxdma_descr;
841		}
842
843		err = au1550_spi_dma_rxtmp_alloc(hw,
844			AU1550_SPI_DMA_RXTMP_MINSIZE);
845		if (err < 0) {
846			dev_err(&pdev->dev,
847				"Cannot allocate initial rx dma tmp buffer\n");
848			goto err_dma_rxtmp_alloc;
849		}
850	}
851
852	au1550_spi_bits_handlers_set(hw, 8);
853
854	err = request_irq(hw->irq, au1550_spi_irq, 0, pdev->name, hw);
855	if (err) {
856		dev_err(&pdev->dev, "Cannot claim IRQ\n");
857		goto err_no_irq;
858	}
859
860	master->bus_num = pdev->id;
861	master->num_chipselect = hw->pdata->num_chipselect;
862
863	/*
864	 *  precompute valid range for spi freq - from au1550 datasheet:
865	 *    psc_tempclk = psc_mainclk / (2 << DIV)
866	 *    spiclk = psc_tempclk / (2 * (BRG + 1))
867	 *    BRG valid range is 4..63
868	 *    DIV valid range is 0..3
869	 *  round the min and max frequencies to values that would still
870	 *  produce valid brg and div
871	 */
872	{
873		int min_div = (2 << 0) * (2 * (4 + 1));
874		int max_div = (2 << 3) * (2 * (63 + 1));
875		master->max_speed_hz = hw->pdata->mainclk_hz / min_div;
876		master->min_speed_hz =
877				hw->pdata->mainclk_hz / (max_div + 1) + 1;
878	}
879
880	au1550_spi_setup_psc_as_spi(hw);
881
882	err = spi_bitbang_start(&hw->bitbang);
883	if (err) {
884		dev_err(&pdev->dev, "Failed to register SPI master\n");
885		goto err_register;
886	}
887
888	dev_info(&pdev->dev,
889		"spi master registered: bus_num=%d num_chipselect=%d\n",
890		master->bus_num, master->num_chipselect);
891
892	return 0;
893
894err_register:
895	free_irq(hw->irq, hw);
896
897err_no_irq:
898	au1550_spi_dma_rxtmp_free(hw);
899
900err_dma_rxtmp_alloc:
901err_no_rxdma_descr:
902	if (hw->usedma)
903		au1xxx_dbdma_chan_free(hw->dma_rx_ch);
904
905err_no_rxdma:
906err_no_txdma_descr:
907	if (hw->usedma)
908		au1xxx_dbdma_chan_free(hw->dma_tx_ch);
909
910err_no_txdma:
911	iounmap((void __iomem *)hw->regs);
912
913err_ioremap:
914	release_mem_region(r->start, sizeof(psc_spi_t));
915
916err_no_iores:
917err_no_pdata:
918	spi_master_put(hw->master);
919
920err_nomem:
921	return err;
922}
923
924static int au1550_spi_remove(struct platform_device *pdev)
925{
926	struct au1550_spi *hw = platform_get_drvdata(pdev);
927
928	dev_info(&pdev->dev, "spi master remove: bus_num=%d\n",
929		hw->master->bus_num);
930
931	spi_bitbang_stop(&hw->bitbang);
932	free_irq(hw->irq, hw);
933	iounmap((void __iomem *)hw->regs);
934	release_mem_region(hw->ioarea->start, sizeof(psc_spi_t));
935
936	if (hw->usedma) {
937		au1550_spi_dma_rxtmp_free(hw);
938		au1xxx_dbdma_chan_free(hw->dma_rx_ch);
939		au1xxx_dbdma_chan_free(hw->dma_tx_ch);
940	}
941
942	spi_master_put(hw->master);
943	return 0;
944}
945
946/* work with hotplug and coldplug */
947MODULE_ALIAS("platform:au1550-spi");
948
949static struct platform_driver au1550_spi_drv = {
950	.probe = au1550_spi_probe,
951	.remove = au1550_spi_remove,
952	.driver = {
953		.name = "au1550-spi",
954	},
955};
956
957static int __init au1550_spi_init(void)
958{
959	/*
960	 * create memory device with 8 bits dev_devwidth
961	 * needed for proper byte ordering to spi fifo
962	 */
963	switch (alchemy_get_cputype()) {
964	case ALCHEMY_CPU_AU1550:
965	case ALCHEMY_CPU_AU1200:
966	case ALCHEMY_CPU_AU1300:
967		break;
968	default:
969		return -ENODEV;
970	}
971
972	if (usedma) {
973		ddma_memid = au1xxx_ddma_add_device(&au1550_spi_mem_dbdev);
974		if (!ddma_memid)
975			printk(KERN_ERR "au1550-spi: cannot add memory"
976					"dbdma device\n");
977	}
978	return platform_driver_register(&au1550_spi_drv);
979}
980module_init(au1550_spi_init);
981
982static void __exit au1550_spi_exit(void)
983{
984	if (usedma && ddma_memid)
985		au1xxx_ddma_del_device(ddma_memid);
986	platform_driver_unregister(&au1550_spi_drv);
987}
988module_exit(au1550_spi_exit);
989
990MODULE_DESCRIPTION("Au1550 PSC SPI Driver");
991MODULE_AUTHOR("Jan Nikitenko <jan.nikitenko@gmail.com>");
992MODULE_LICENSE("GPL");