1 // SPDX-License-Identifier: GPL-2.0+
15 #include <spi-mem.h>
20  * spi_controller_dma_map_mem_op_data() - DMA-map the buffer attached to a
23  * @op: the memory operation containing the buffer to map
24  * @sgt: a pointer to a non-initialized sg_table that will be filled by this
27  * Some controllers might want to do DMA on the data buffer embedded in @op.
28  * This helper prepares everything for you and provides a ready-to-use
32  * op->data.buf.{in,out} is DMA-able before calling this function.
37 				       const struct spi_mem_op *op,  in spi_controller_dma_map_mem_op_data()  argument
42 	if (!op->data.nbytes)  in spi_controller_dma_map_mem_op_data()
43 		return -EINVAL;  in spi_controller_dma_map_mem_op_data()
45 	if (op->data.dir == SPI_MEM_DATA_OUT && ctlr->dma_tx)  in spi_controller_dma_map_mem_op_data()
46 		dmadev = ctlr->dma_tx->device->dev;  in spi_controller_dma_map_mem_op_data()
47 	else if (op->data.dir == SPI_MEM_DATA_IN && ctlr->dma_rx)  in spi_controller_dma_map_mem_op_data()
48 		dmadev = ctlr->dma_rx->device->dev;  in spi_controller_dma_map_mem_op_data()
50 		dmadev = ctlr->dev.parent;  in spi_controller_dma_map_mem_op_data()
53 		return -EINVAL;  in spi_controller_dma_map_mem_op_data()
55 	return spi_map_buf(ctlr, dmadev, sgt, op->data.buf.in, op->data.nbytes,  in spi_controller_dma_map_mem_op_data()
56 			   op->data.dir == SPI_MEM_DATA_IN ?  in spi_controller_dma_map_mem_op_data()
62  * spi_controller_dma_unmap_mem_op_data() - DMA-unmap the buffer attached to a
65  * @op: the memory operation containing the buffer to unmap
69  * Some controllers might want to do DMA on the data buffer embedded in @op.
71  * op->data.buf.{in,out} buffer again.
83 					  const struct spi_mem_op *op,  in spi_controller_dma_unmap_mem_op_data()  argument
88 	if (!op->data.nbytes)  in spi_controller_dma_unmap_mem_op_data()
91 	if (op->data.dir == SPI_MEM_DATA_OUT && ctlr->dma_tx)  in spi_controller_dma_unmap_mem_op_data()
92 		dmadev = ctlr->dma_tx->device->dev;  in spi_controller_dma_unmap_mem_op_data()
93 	else if (op->data.dir == SPI_MEM_DATA_IN && ctlr->dma_rx)  in spi_controller_dma_unmap_mem_op_data()
94 		dmadev = ctlr->dma_rx->device->dev;  in spi_controller_dma_unmap_mem_op_data()
96 		dmadev = ctlr->dev.parent;  in spi_controller_dma_unmap_mem_op_data()
99 		      op->data.dir == SPI_MEM_DATA_IN ?  in spi_controller_dma_unmap_mem_op_data()
107 	u32 mode = slave->mode;  in spi_check_buswidth_req()  local
114 		if ((tx && (mode & (SPI_TX_DUAL | SPI_TX_QUAD))) ||  in spi_check_buswidth_req()
115 		    (!tx && (mode & (SPI_RX_DUAL | SPI_RX_QUAD))))  in spi_check_buswidth_req()
121 		if ((tx && (mode & SPI_TX_QUAD)) ||  in spi_check_buswidth_req()
122 		    (!tx && (mode & SPI_RX_QUAD)))  in spi_check_buswidth_req()
131 	return -ENOTSUPP;  in spi_check_buswidth_req()
135 				 const struct spi_mem_op *op)  in spi_mem_default_supports_op()  argument
137 	if (spi_check_buswidth_req(slave, op->cmd.buswidth, true))  in spi_mem_default_supports_op()
140 	if (op->addr.nbytes &&  in spi_mem_default_supports_op()
141 	    spi_check_buswidth_req(slave, op->addr.buswidth, true))  in spi_mem_default_supports_op()
144 	if (op->dummy.nbytes &&  in spi_mem_default_supports_op()
145 	    spi_check_buswidth_req(slave, op->dummy.buswidth, true))  in spi_mem_default_supports_op()
148 	if (op->data.nbytes &&  in spi_mem_default_supports_op()
149 	    spi_check_buswidth_req(slave, op->data.buswidth,  in spi_mem_default_supports_op()
150 				   op->data.dir == SPI_MEM_DATA_OUT))  in spi_mem_default_supports_op()
158  * spi_mem_supports_op() - Check if a memory device and the controller it is
161  * @op: the memory operation to check
170  * Return: true if @op is supported, false otherwise.
173 			 const struct spi_mem_op *op)  in spi_mem_supports_op()  argument
175 	struct udevice *bus = slave->dev->parent;  in spi_mem_supports_op()
178 	if (ops->mem_ops && ops->mem_ops->supports_op)  in spi_mem_supports_op()
179 		return ops->mem_ops->supports_op(slave, op);  in spi_mem_supports_op()
181 	return spi_mem_default_supports_op(slave, op);  in spi_mem_supports_op()
186  * spi_mem_exec_op() - Execute a memory operation
188  * @op: the memory operation to execute
192  * This function first checks that @op is supported and then tries to execute
197 int spi_mem_exec_op(struct spi_slave *slave, const struct spi_mem_op *op)  in spi_mem_exec_op()  argument
199 	struct udevice *bus = slave->dev->parent;  in spi_mem_exec_op()
210 	if (!spi_mem_supports_op(slave, op))  in spi_mem_exec_op()
211 		return -ENOTSUPP;  in spi_mem_exec_op()
217 	if (ops->mem_ops) {  in spi_mem_exec_op()
225 		if (ctlr->auto_runtime_pm) {  in spi_mem_exec_op()
226 			ret = pm_runtime_get_sync(ctlr->dev.parent);  in spi_mem_exec_op()
228 				dev_err(&ctlr->dev,  in spi_mem_exec_op()
235 		mutex_lock(&ctlr->bus_lock_mutex);  in spi_mem_exec_op()
236 		mutex_lock(&ctlr->io_mutex);  in spi_mem_exec_op()
238 		ret = ops->mem_ops->exec_op(slave, op);  in spi_mem_exec_op()
241 		mutex_unlock(&ctlr->io_mutex);  in spi_mem_exec_op()
242 		mutex_unlock(&ctlr->bus_lock_mutex);  in spi_mem_exec_op()
244 		if (ctlr->auto_runtime_pm)  in spi_mem_exec_op()
245 			pm_runtime_put(ctlr->dev.parent);  in spi_mem_exec_op()
253 		if (!ret || ret != -ENOTSUPP) {  in spi_mem_exec_op()
260 	tmpbufsize = sizeof(op->cmd.opcode) + op->addr.nbytes +  in spi_mem_exec_op()
261 		     op->dummy.nbytes;  in spi_mem_exec_op()
265 	 * we're guaranteed that this buffer is DMA-able, as required by the  in spi_mem_exec_op()
270 		return -ENOMEM;  in spi_mem_exec_op()
274 	tmpbuf[0] = op->cmd.opcode;  in spi_mem_exec_op()
276 	xfers[xferpos].len = sizeof(op->cmd.opcode);  in spi_mem_exec_op()
277 	xfers[xferpos].tx_nbits = op->cmd.buswidth;  in spi_mem_exec_op()
282 	if (op->addr.nbytes) {  in spi_mem_exec_op()
285 		for (i = 0; i < op->addr.nbytes; i++)  in spi_mem_exec_op()
286 			tmpbuf[i + 1] = op->addr.val >>  in spi_mem_exec_op()
287 					(8 * (op->addr.nbytes - i - 1));  in spi_mem_exec_op()
290 		xfers[xferpos].len = op->addr.nbytes;  in spi_mem_exec_op()
291 		xfers[xferpos].tx_nbits = op->addr.buswidth;  in spi_mem_exec_op()
294 		totalxferlen += op->addr.nbytes;  in spi_mem_exec_op()
297 	if (op->dummy.nbytes) {  in spi_mem_exec_op()
298 		memset(tmpbuf + op->addr.nbytes + 1, 0xff, op->dummy.nbytes);  in spi_mem_exec_op()
299 		xfers[xferpos].tx_buf = tmpbuf + op->addr.nbytes + 1;  in spi_mem_exec_op()
300 		xfers[xferpos].len = op->dummy.nbytes;  in spi_mem_exec_op()
301 		xfers[xferpos].tx_nbits = op->dummy.buswidth;  in spi_mem_exec_op()
304 		totalxferlen += op->dummy.nbytes;  in spi_mem_exec_op()
307 	if (op->data.nbytes) {  in spi_mem_exec_op()
308 		if (op->data.dir == SPI_MEM_DATA_IN) {  in spi_mem_exec_op()
309 			xfers[xferpos].rx_buf = op->data.buf.in;  in spi_mem_exec_op()
310 			xfers[xferpos].rx_nbits = op->data.buswidth;  in spi_mem_exec_op()
312 			xfers[xferpos].tx_buf = op->data.buf.out;  in spi_mem_exec_op()
313 			xfers[xferpos].tx_nbits = op->data.buswidth;  in spi_mem_exec_op()
316 		xfers[xferpos].len = op->data.nbytes;  in spi_mem_exec_op()
319 		totalxferlen += op->data.nbytes;  in spi_mem_exec_op()
330 		return -EIO;  in spi_mem_exec_op()
333 	if (op->data.nbytes) {  in spi_mem_exec_op()
334 		if (op->data.dir == SPI_MEM_DATA_IN)  in spi_mem_exec_op()
335 			rx_buf = op->data.buf.in;  in spi_mem_exec_op()
337 			tx_buf = op->data.buf.out;  in spi_mem_exec_op()
340 	op_len = sizeof(op->cmd.opcode) + op->addr.nbytes + op->dummy.nbytes;  in spi_mem_exec_op()
343 	op_buf[pos++] = op->cmd.opcode;  in spi_mem_exec_op()
345 	if (op->addr.nbytes) {  in spi_mem_exec_op()
346 		for (i = 0; i < op->addr.nbytes; i++)  in spi_mem_exec_op()
347 			op_buf[pos + i] = op->addr.val >>  in spi_mem_exec_op()
348 				(8 * (op->addr.nbytes - i - 1));  in spi_mem_exec_op()
350 		pos += op->addr.nbytes;  in spi_mem_exec_op()
353 	if (op->dummy.nbytes)  in spi_mem_exec_op()
354 		memset(op_buf + pos, 0xff, op->dummy.nbytes);  in spi_mem_exec_op()
368 		ret = spi_xfer(slave, op->data.nbytes * 8, tx_buf,  in spi_mem_exec_op()
379 	      tx_buf || rx_buf ? op->data.nbytes : 0,  in spi_mem_exec_op()
380 	      tx_buf || rx_buf ? (tx_buf ? "out" : "in") : "-");  in spi_mem_exec_op()
381 	for (i = 0; i < op->data.nbytes; i++)  in spi_mem_exec_op()
396  * spi_mem_adjust_op_size() - Adjust the data size of a SPI mem operation to
399  * @op: the operation to adjust
404  * operation into multiple sub-operations when required.
406  * Return: a negative error code if the controller can't properly adjust @op,
407  *	   0 otherwise. Note that @op->data.nbytes will be updated if @op
410 int spi_mem_adjust_op_size(struct spi_slave *slave, struct spi_mem_op *op)  in spi_mem_adjust_op_size()  argument
412 	struct udevice *bus = slave->dev->parent;  in spi_mem_adjust_op_size()
415 	if (ops->mem_ops && ops->mem_ops->adjust_op_size)  in spi_mem_adjust_op_size()
416 		return ops->mem_ops->adjust_op_size(slave, op);  in spi_mem_adjust_op_size()
418 	if (!ops->mem_ops || !ops->mem_ops->exec_op) {  in spi_mem_adjust_op_size()
421 		len = sizeof(op->cmd.opcode) + op->addr.nbytes +  in spi_mem_adjust_op_size()
422 			op->dummy.nbytes;  in spi_mem_adjust_op_size()
423 		if (slave->max_write_size && len > slave->max_write_size)  in spi_mem_adjust_op_size()
424 			return -EINVAL;  in spi_mem_adjust_op_size()
426 		if (op->data.dir == SPI_MEM_DATA_IN && slave->max_read_size)  in spi_mem_adjust_op_size()
427 			op->data.nbytes = min(op->data.nbytes,  in spi_mem_adjust_op_size()
428 					      slave->max_read_size);  in spi_mem_adjust_op_size()
429 		else if (slave->max_write_size)  in spi_mem_adjust_op_size()
430 			op->data.nbytes = min(op->data.nbytes,  in spi_mem_adjust_op_size()
431 					      slave->max_write_size - len);  in spi_mem_adjust_op_size()
433 		if (!op->data.nbytes)  in spi_mem_adjust_op_size()
434 			return -EINVAL;  in spi_mem_adjust_op_size()
449 	struct spi_mem_driver *memdrv = to_spi_mem_drv(spi->dev.driver);  in spi_mem_probe()
452 	mem = devm_kzalloc(&spi->dev, sizeof(*mem), GFP_KERNEL);  in spi_mem_probe()
454 		return -ENOMEM;  in spi_mem_probe()
456 	mem->spi = spi;  in spi_mem_probe()
459 	return memdrv->probe(mem);  in spi_mem_probe()
464 	struct spi_mem_driver *memdrv = to_spi_mem_drv(spi->dev.driver);  in spi_mem_remove()
467 	if (memdrv->remove)  in spi_mem_remove()
468 		return memdrv->remove(mem);  in spi_mem_remove()
475 	struct spi_mem_driver *memdrv = to_spi_mem_drv(spi->dev.driver);  in spi_mem_shutdown()
478 	if (memdrv->shutdown)  in spi_mem_shutdown()
479 		memdrv->shutdown(mem);  in spi_mem_shutdown()
483  * spi_mem_driver_register_with_owner() - Register a SPI memory driver
495 	memdrv->spidrv.probe = spi_mem_probe;  in spi_mem_driver_register_with_owner()
496 	memdrv->spidrv.remove = spi_mem_remove;  in spi_mem_driver_register_with_owner()
497 	memdrv->spidrv.shutdown = spi_mem_shutdown;  in spi_mem_driver_register_with_owner()
499 	return __spi_register_driver(owner, &memdrv->spidrv);  in spi_mem_driver_register_with_owner()
504  * spi_mem_driver_unregister_with_owner() - Unregister a SPI memory driver
511 	spi_unregister_driver(&memdrv->spidrv);  in spi_mem_driver_unregister()