1 // SPDX-License-Identifier: GPL-2.0+
12 #include <linux/spi/spi-mem.h>
19  * spi_controller_dma_map_mem_op_data() - DMA-map the buffer attached to a
23  * @sgt: a pointer to a non-initialized sg_table that will be filled by this
26  * Some controllers might want to do DMA on the data buffer embedded in @op.
27  * This helper prepares everything for you and provides a ready-to-use
31  * op->data.buf.{in,out} is DMA-able before calling this function.
41 	if (!op->data.nbytes)  in spi_controller_dma_map_mem_op_data()
42 		return -EINVAL;  in spi_controller_dma_map_mem_op_data()
44 	if (op->data.dir == SPI_MEM_DATA_OUT && ctlr->dma_tx)  in spi_controller_dma_map_mem_op_data()
45 		dmadev = ctlr->dma_tx->device->dev;  in spi_controller_dma_map_mem_op_data()
46 	else if (op->data.dir == SPI_MEM_DATA_IN && ctlr->dma_rx)  in spi_controller_dma_map_mem_op_data()
47 		dmadev = ctlr->dma_rx->device->dev;  in spi_controller_dma_map_mem_op_data()
49 		dmadev = ctlr->dev.parent;  in spi_controller_dma_map_mem_op_data()
52 		return -EINVAL;  in spi_controller_dma_map_mem_op_data()
54 	return spi_map_buf(ctlr, dmadev, sgt, op->data.buf.in, op->data.nbytes,  in spi_controller_dma_map_mem_op_data()
55 			   op->data.dir == SPI_MEM_DATA_IN ?  in spi_controller_dma_map_mem_op_data()
61  * spi_controller_dma_unmap_mem_op_data() - DMA-unmap the buffer attached to a
68  * Some controllers might want to do DMA on the data buffer embedded in @op.
70  * op->data.buf.{in,out} buffer again.
87 	if (!op->data.nbytes)  in spi_controller_dma_unmap_mem_op_data()
90 	if (op->data.dir == SPI_MEM_DATA_OUT && ctlr->dma_tx)  in spi_controller_dma_unmap_mem_op_data()
91 		dmadev = ctlr->dma_tx->device->dev;  in spi_controller_dma_unmap_mem_op_data()
92 	else if (op->data.dir == SPI_MEM_DATA_IN && ctlr->dma_rx)  in spi_controller_dma_unmap_mem_op_data()
93 		dmadev = ctlr->dma_rx->device->dev;  in spi_controller_dma_unmap_mem_op_data()
95 		dmadev = ctlr->dev.parent;  in spi_controller_dma_unmap_mem_op_data()
98 		      op->data.dir == SPI_MEM_DATA_IN ?  in spi_controller_dma_unmap_mem_op_data()
105 	u32 mode = mem->spi->mode;  in spi_check_buswidth_req()
138 	return -ENOTSUPP;  in spi_check_buswidth_req()
144 	if (spi_check_buswidth_req(mem, op->cmd.buswidth, true))  in spi_mem_check_buswidth()
147 	if (op->addr.nbytes &&  in spi_mem_check_buswidth()
148 	    spi_check_buswidth_req(mem, op->addr.buswidth, true))  in spi_mem_check_buswidth()
151 	if (op->dummy.nbytes &&  in spi_mem_check_buswidth()
152 	    spi_check_buswidth_req(mem, op->dummy.buswidth, true))  in spi_mem_check_buswidth()
155 	if (op->data.dir != SPI_MEM_NO_DATA &&  in spi_mem_check_buswidth()
156 	    spi_check_buswidth_req(mem, op->data.buswidth,  in spi_mem_check_buswidth()
157 				   op->data.dir == SPI_MEM_DATA_OUT))  in spi_mem_check_buswidth()
166 	if (op->cmd.nbytes != 2)  in spi_mem_dtr_supports_op()
176 	if (op->cmd.dtr || op->addr.dtr || op->dummy.dtr || op->data.dtr)  in spi_mem_default_supports_op()
179 	if (op->cmd.nbytes != 1)  in spi_mem_default_supports_op()
196 	if (!op->cmd.buswidth || !op->cmd.nbytes)  in spi_mem_check_op()
197 		return -EINVAL;  in spi_mem_check_op()
199 	if ((op->addr.nbytes && !op->addr.buswidth) ||  in spi_mem_check_op()
200 	    (op->dummy.nbytes && !op->dummy.buswidth) ||  in spi_mem_check_op()
201 	    (op->data.nbytes && !op->data.buswidth))  in spi_mem_check_op()
202 		return -EINVAL;  in spi_mem_check_op()
204 	if (!spi_mem_buswidth_is_valid(op->cmd.buswidth) ||  in spi_mem_check_op()
205 	    !spi_mem_buswidth_is_valid(op->addr.buswidth) ||  in spi_mem_check_op()
206 	    !spi_mem_buswidth_is_valid(op->dummy.buswidth) ||  in spi_mem_check_op()
207 	    !spi_mem_buswidth_is_valid(op->data.buswidth))  in spi_mem_check_op()
208 		return -EINVAL;  in spi_mem_check_op()
216 	struct spi_controller *ctlr = mem->spi->controller;  in spi_mem_internal_supports_op()
218 	if (ctlr->mem_ops && ctlr->mem_ops->supports_op)  in spi_mem_internal_supports_op()
219 		return ctlr->mem_ops->supports_op(mem, op);  in spi_mem_internal_supports_op()
225  * spi_mem_supports_op() - Check if a memory device and the controller it is
250 	struct spi_controller *ctlr = mem->spi->controller;  in spi_mem_access_start()
258 	if (ctlr->auto_runtime_pm) {  in spi_mem_access_start()
261 		ret = pm_runtime_get_sync(ctlr->dev.parent);  in spi_mem_access_start()
263 			pm_runtime_put_noidle(ctlr->dev.parent);  in spi_mem_access_start()
264 			dev_err(&ctlr->dev, "Failed to power device: %d\n",  in spi_mem_access_start()
270 	mutex_lock(&ctlr->bus_lock_mutex);  in spi_mem_access_start()
271 	mutex_lock(&ctlr->io_mutex);  in spi_mem_access_start()
278 	struct spi_controller *ctlr = mem->spi->controller;  in spi_mem_access_end()
280 	mutex_unlock(&ctlr->io_mutex);  in spi_mem_access_end()
281 	mutex_unlock(&ctlr->bus_lock_mutex);  in spi_mem_access_end()
283 	if (ctlr->auto_runtime_pm)  in spi_mem_access_end()
284 		pm_runtime_put(ctlr->dev.parent);  in spi_mem_access_end()
288  * spi_mem_exec_op() - Execute a memory operation
302 	struct spi_controller *ctlr = mem->spi->controller;  in spi_mem_exec_op()
313 		return -ENOTSUPP;  in spi_mem_exec_op()
315 	if (ctlr->mem_ops && !mem->spi->cs_gpiod) {  in spi_mem_exec_op()
320 		ret = ctlr->mem_ops->exec_op(mem, op);  in spi_mem_exec_op()
329 		if (!ret || ret != -ENOTSUPP)  in spi_mem_exec_op()
333 	tmpbufsize = op->cmd.nbytes + op->addr.nbytes + op->dummy.nbytes;  in spi_mem_exec_op()
337 	 * we're guaranteed that this buffer is DMA-able, as required by the  in spi_mem_exec_op()
342 		return -ENOMEM;  in spi_mem_exec_op()
346 	tmpbuf[0] = op->cmd.opcode;  in spi_mem_exec_op()
348 	xfers[xferpos].len = op->cmd.nbytes;  in spi_mem_exec_op()
349 	xfers[xferpos].tx_nbits = op->cmd.buswidth;  in spi_mem_exec_op()
354 	if (op->addr.nbytes) {  in spi_mem_exec_op()
357 		for (i = 0; i < op->addr.nbytes; i++)  in spi_mem_exec_op()
358 			tmpbuf[i + 1] = op->addr.val >>  in spi_mem_exec_op()
359 					(8 * (op->addr.nbytes - i - 1));  in spi_mem_exec_op()
362 		xfers[xferpos].len = op->addr.nbytes;  in spi_mem_exec_op()
363 		xfers[xferpos].tx_nbits = op->addr.buswidth;  in spi_mem_exec_op()
366 		totalxferlen += op->addr.nbytes;  in spi_mem_exec_op()
369 	if (op->dummy.nbytes) {  in spi_mem_exec_op()
370 		memset(tmpbuf + op->addr.nbytes + 1, 0xff, op->dummy.nbytes);  in spi_mem_exec_op()
371 		xfers[xferpos].tx_buf = tmpbuf + op->addr.nbytes + 1;  in spi_mem_exec_op()
372 		xfers[xferpos].len = op->dummy.nbytes;  in spi_mem_exec_op()
373 		xfers[xferpos].tx_nbits = op->dummy.buswidth;  in spi_mem_exec_op()
377 		totalxferlen += op->dummy.nbytes;  in spi_mem_exec_op()
380 	if (op->data.nbytes) {  in spi_mem_exec_op()
381 		if (op->data.dir == SPI_MEM_DATA_IN) {  in spi_mem_exec_op()
382 			xfers[xferpos].rx_buf = op->data.buf.in;  in spi_mem_exec_op()
383 			xfers[xferpos].rx_nbits = op->data.buswidth;  in spi_mem_exec_op()
385 			xfers[xferpos].tx_buf = op->data.buf.out;  in spi_mem_exec_op()
386 			xfers[xferpos].tx_nbits = op->data.buswidth;  in spi_mem_exec_op()
389 		xfers[xferpos].len = op->data.nbytes;  in spi_mem_exec_op()
392 		totalxferlen += op->data.nbytes;  in spi_mem_exec_op()
395 	ret = spi_sync(mem->spi, &msg);  in spi_mem_exec_op()
403 		return -EIO;  in spi_mem_exec_op()
410  * spi_mem_get_name() - Return the SPI mem device name to be used by the
423 	return mem->name;  in spi_mem_get_name()
428  * spi_mem_adjust_op_size() - Adjust the data size of a SPI mem operation to
433  * Some controllers have FIFO limitations and must split a data transfer
436  * operation into multiple sub-operations when required.
439  *	   0 otherwise. Note that @op->data.nbytes will be updated if @op
444 	struct spi_controller *ctlr = mem->spi->controller;  in spi_mem_adjust_op_size()
447 	if (ctlr->mem_ops && ctlr->mem_ops->adjust_op_size)  in spi_mem_adjust_op_size()
448 		return ctlr->mem_ops->adjust_op_size(mem, op);  in spi_mem_adjust_op_size()
450 	if (!ctlr->mem_ops || !ctlr->mem_ops->exec_op) {  in spi_mem_adjust_op_size()
451 		len = op->cmd.nbytes + op->addr.nbytes + op->dummy.nbytes;  in spi_mem_adjust_op_size()
453 		if (len > spi_max_transfer_size(mem->spi))  in spi_mem_adjust_op_size()
454 			return -EINVAL;  in spi_mem_adjust_op_size()
456 		op->data.nbytes = min3((size_t)op->data.nbytes,  in spi_mem_adjust_op_size()
457 				       spi_max_transfer_size(mem->spi),  in spi_mem_adjust_op_size()
458 				       spi_max_message_size(mem->spi) -  in spi_mem_adjust_op_size()
460 		if (!op->data.nbytes)  in spi_mem_adjust_op_size()
461 			return -EINVAL;  in spi_mem_adjust_op_size()
471 	struct spi_mem_op op = desc->info.op_tmpl;  in spi_mem_no_dirmap_read()
474 	op.addr.val = desc->info.offset + offs;  in spi_mem_no_dirmap_read()
475 	op.data.buf.in = buf;  in spi_mem_no_dirmap_read()
476 	op.data.nbytes = len;  in spi_mem_no_dirmap_read()
477 	ret = spi_mem_adjust_op_size(desc->mem, &op);  in spi_mem_no_dirmap_read()
481 	ret = spi_mem_exec_op(desc->mem, &op);  in spi_mem_no_dirmap_read()
485 	return op.data.nbytes;  in spi_mem_no_dirmap_read()
491 	struct spi_mem_op op = desc->info.op_tmpl;  in spi_mem_no_dirmap_write()
494 	op.addr.val = desc->info.offset + offs;  in spi_mem_no_dirmap_write()
495 	op.data.buf.out = buf;  in spi_mem_no_dirmap_write()
496 	op.data.nbytes = len;  in spi_mem_no_dirmap_write()
497 	ret = spi_mem_adjust_op_size(desc->mem, &op);  in spi_mem_no_dirmap_write()
501 	ret = spi_mem_exec_op(desc->mem, &op);  in spi_mem_no_dirmap_write()
505 	return op.data.nbytes;  in spi_mem_no_dirmap_write()
509  * spi_mem_dirmap_create() - Create a direct mapping descriptor
510  * @mem: SPI mem device this direct mapping should be created for
511  * @info: direct mapping information
513  * This function is creating a direct mapping descriptor which can then be used
515  * If the SPI controller driver does not support direct mapping, this function
525 	struct spi_controller *ctlr = mem->spi->controller;  in spi_mem_dirmap_create()
527 	int ret = -ENOTSUPP;  in spi_mem_dirmap_create()
530 	if (!info->op_tmpl.addr.nbytes || info->op_tmpl.addr.nbytes > 8)  in spi_mem_dirmap_create()
531 		return ERR_PTR(-EINVAL);  in spi_mem_dirmap_create()
533 	/* data.dir should either be SPI_MEM_DATA_IN or SPI_MEM_DATA_OUT. */  in spi_mem_dirmap_create()
534 	if (info->op_tmpl.data.dir == SPI_MEM_NO_DATA)  in spi_mem_dirmap_create()
535 		return ERR_PTR(-EINVAL);  in spi_mem_dirmap_create()
539 		return ERR_PTR(-ENOMEM);  in spi_mem_dirmap_create()
541 	desc->mem = mem;  in spi_mem_dirmap_create()
542 	desc->info = *info;  in spi_mem_dirmap_create()
543 	if (ctlr->mem_ops && ctlr->mem_ops->dirmap_create)  in spi_mem_dirmap_create()
544 		ret = ctlr->mem_ops->dirmap_create(desc);  in spi_mem_dirmap_create()
547 		desc->nodirmap = true;  in spi_mem_dirmap_create()
548 		if (!spi_mem_supports_op(desc->mem, &desc->info.op_tmpl))  in spi_mem_dirmap_create()
549 			ret = -ENOTSUPP;  in spi_mem_dirmap_create()
564  * spi_mem_dirmap_destroy() - Destroy a direct mapping descriptor
565  * @desc: the direct mapping descriptor to destroy
567  * This function destroys a direct mapping descriptor previously created by
572 	struct spi_controller *ctlr = desc->mem->spi->controller;  in spi_mem_dirmap_destroy()
574 	if (!desc->nodirmap && ctlr->mem_ops && ctlr->mem_ops->dirmap_destroy)  in spi_mem_dirmap_destroy()
575 		ctlr->mem_ops->dirmap_destroy(desc);  in spi_mem_dirmap_destroy()
589  * devm_spi_mem_dirmap_create() - Create a direct mapping descriptor and attach
592  * @mem: SPI mem device this direct mapping should be created for
593  * @info: direct mapping information
609 		return ERR_PTR(-ENOMEM);  in devm_spi_mem_dirmap_create()
623 static int devm_spi_mem_dirmap_match(struct device *dev, void *res, void *data)  in devm_spi_mem_dirmap_match()  argument
630 	return *ptr == data;  in devm_spi_mem_dirmap_match()
634  * devm_spi_mem_dirmap_destroy() - Destroy a direct mapping descriptor attached
637  * @desc: the direct mapping descriptor to destroy
651  * spi_mem_dirmap_read() - Read data through a direct mapping
652  * @desc: direct mapping descriptor
654  *	  offset, but the offset within the direct mapping which already has
657  * @buf: destination buffer. This buffer must be DMA-able
659  * This function reads data from a memory device using a direct mapping
662  * Return: the amount of data read from the memory device or a negative error
669 	struct spi_controller *ctlr = desc->mem->spi->controller;  in spi_mem_dirmap_read()
672 	if (desc->info.op_tmpl.data.dir != SPI_MEM_DATA_IN)  in spi_mem_dirmap_read()
673 		return -EINVAL;  in spi_mem_dirmap_read()
678 	if (desc->nodirmap) {  in spi_mem_dirmap_read()
680 	} else if (ctlr->mem_ops && ctlr->mem_ops->dirmap_read) {  in spi_mem_dirmap_read()
681 		ret = spi_mem_access_start(desc->mem);  in spi_mem_dirmap_read()
685 		ret = ctlr->mem_ops->dirmap_read(desc, offs, len, buf);  in spi_mem_dirmap_read()
687 		spi_mem_access_end(desc->mem);  in spi_mem_dirmap_read()
689 		ret = -ENOTSUPP;  in spi_mem_dirmap_read()
697  * spi_mem_dirmap_write() - Write data through a direct mapping
698  * @desc: direct mapping descriptor
700  *	  offset, but the offset within the direct mapping which already has
703  * @buf: source buffer. This buffer must be DMA-able
705  * This function writes data to a memory device using a direct mapping
708  * Return: the amount of data written to the memory device or a negative error
715 	struct spi_controller *ctlr = desc->mem->spi->controller;  in spi_mem_dirmap_write()
718 	if (desc->info.op_tmpl.data.dir != SPI_MEM_DATA_OUT)  in spi_mem_dirmap_write()
719 		return -EINVAL;  in spi_mem_dirmap_write()
724 	if (desc->nodirmap) {  in spi_mem_dirmap_write()
726 	} else if (ctlr->mem_ops && ctlr->mem_ops->dirmap_write) {  in spi_mem_dirmap_write()
727 		ret = spi_mem_access_start(desc->mem);  in spi_mem_dirmap_write()
731 		ret = ctlr->mem_ops->dirmap_write(desc, offs, len, buf);  in spi_mem_dirmap_write()
733 		spi_mem_access_end(desc->mem);  in spi_mem_dirmap_write()
735 		ret = -ENOTSUPP;  in spi_mem_dirmap_write()
751 	const u8 *bytes = (u8 *)op->data.buf.in;  in spi_mem_read_status()
758 	if (op->data.nbytes > 1)  in spi_mem_read_status()
767  * spi_mem_poll_status() - Poll memory device status
779  * Return: 0 in case of success, -ETIMEDOUT in case of error,
780  *         -EOPNOTSUPP if not supported.
789 	struct spi_controller *ctlr = mem->spi->controller;  in spi_mem_poll_status()
790 	int ret = -EOPNOTSUPP;  in spi_mem_poll_status()
794 	if (op->data.nbytes < 1 || op->data.nbytes > 2 ||  in spi_mem_poll_status()
795 	    op->data.dir != SPI_MEM_DATA_IN)  in spi_mem_poll_status()
796 		return -EINVAL;  in spi_mem_poll_status()
798 	if (ctlr->mem_ops && ctlr->mem_ops->poll_status) {  in spi_mem_poll_status()
803 		ret = ctlr->mem_ops->poll_status(mem, op, mask, match,  in spi_mem_poll_status()
810 	if (ret == -EOPNOTSUPP) {  in spi_mem_poll_status()
834 	struct spi_mem_driver *memdrv = to_spi_mem_drv(spi->dev.driver);  in spi_mem_probe()
835 	struct spi_controller *ctlr = spi->controller;  in spi_mem_probe()
838 	mem = devm_kzalloc(&spi->dev, sizeof(*mem), GFP_KERNEL);  in spi_mem_probe()
840 		return -ENOMEM;  in spi_mem_probe()
842 	mem->spi = spi;  in spi_mem_probe()
844 	if (ctlr->mem_ops && ctlr->mem_ops->get_name)  in spi_mem_probe()
845 		mem->name = ctlr->mem_ops->get_name(mem);  in spi_mem_probe()
847 		mem->name = dev_name(&spi->dev);  in spi_mem_probe()
849 	if (IS_ERR_OR_NULL(mem->name))  in spi_mem_probe()
850 		return PTR_ERR_OR_ZERO(mem->name);  in spi_mem_probe()
854 	return memdrv->probe(mem);  in spi_mem_probe()
859 	struct spi_mem_driver *memdrv = to_spi_mem_drv(spi->dev.driver);  in spi_mem_remove()
862 	if (memdrv->remove)  in spi_mem_remove()
863 		return memdrv->remove(mem);  in spi_mem_remove()
870 	struct spi_mem_driver *memdrv = to_spi_mem_drv(spi->dev.driver);  in spi_mem_shutdown()
873 	if (memdrv->shutdown)  in spi_mem_shutdown()
874 		memdrv->shutdown(mem);  in spi_mem_shutdown()
878  * spi_mem_driver_register_with_owner() - Register a SPI memory driver
890 	memdrv->spidrv.probe = spi_mem_probe;  in spi_mem_driver_register_with_owner()
891 	memdrv->spidrv.remove = spi_mem_remove;  in spi_mem_driver_register_with_owner()
892 	memdrv->spidrv.shutdown = spi_mem_shutdown;  in spi_mem_driver_register_with_owner()
894 	return __spi_register_driver(owner, &memdrv->spidrv);  in spi_mem_driver_register_with_owner()
899  * spi_mem_driver_unregister() - Unregister a SPI memory driver
906 	spi_unregister_driver(&memdrv->spidrv);  in spi_mem_driver_unregister()