xref: /linux/drivers/mtd/nand/spi/winbond.c (revision e9f0878c4b2004ac19581274c1ae4c61ae3ca70e)
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Copyright (c) 2017 exceet electronics GmbH
4  *
5  * Authors:
6  *	Frieder Schrempf <frieder.schrempf@exceet.de>
7  *	Boris Brezillon <boris.brezillon@bootlin.com>
8  */
9 
10 #include <linux/device.h>
11 #include <linux/kernel.h>
12 #include <linux/mtd/spinand.h>
13 
14 #define SPINAND_MFR_WINBOND		0xEF
15 
16 #define WINBOND_CFG_BUF_READ		BIT(3)
17 
18 static SPINAND_OP_VARIANTS(read_cache_variants,
19 		SPINAND_PAGE_READ_FROM_CACHE_QUADIO_OP(0, 2, NULL, 0),
20 		SPINAND_PAGE_READ_FROM_CACHE_X4_OP(0, 1, NULL, 0),
21 		SPINAND_PAGE_READ_FROM_CACHE_DUALIO_OP(0, 1, NULL, 0),
22 		SPINAND_PAGE_READ_FROM_CACHE_X2_OP(0, 1, NULL, 0),
23 		SPINAND_PAGE_READ_FROM_CACHE_OP(true, 0, 1, NULL, 0),
24 		SPINAND_PAGE_READ_FROM_CACHE_OP(false, 0, 1, NULL, 0));
25 
26 static SPINAND_OP_VARIANTS(write_cache_variants,
27 		SPINAND_PROG_LOAD_X4(true, 0, NULL, 0),
28 		SPINAND_PROG_LOAD(true, 0, NULL, 0));
29 
30 static SPINAND_OP_VARIANTS(update_cache_variants,
31 		SPINAND_PROG_LOAD_X4(false, 0, NULL, 0),
32 		SPINAND_PROG_LOAD(false, 0, NULL, 0));
33 
34 static int w25m02gv_ooblayout_ecc(struct mtd_info *mtd, int section,
35 				  struct mtd_oob_region *region)
36 {
37 	if (section > 3)
38 		return -ERANGE;
39 
40 	region->offset = (16 * section) + 8;
41 	region->length = 8;
42 
43 	return 0;
44 }
45 
46 static int w25m02gv_ooblayout_free(struct mtd_info *mtd, int section,
47 				   struct mtd_oob_region *region)
48 {
49 	if (section > 3)
50 		return -ERANGE;
51 
52 	region->offset = (16 * section) + 2;
53 	region->length = 6;
54 
55 	return 0;
56 }
57 
58 static const struct mtd_ooblayout_ops w25m02gv_ooblayout = {
59 	.ecc = w25m02gv_ooblayout_ecc,
60 	.free = w25m02gv_ooblayout_free,
61 };
62 
63 static int w25m02gv_select_target(struct spinand_device *spinand,
64 				  unsigned int target)
65 {
66 	struct spi_mem_op op = SPI_MEM_OP(SPI_MEM_OP_CMD(0xc2, 1),
67 					  SPI_MEM_OP_NO_ADDR,
68 					  SPI_MEM_OP_NO_DUMMY,
69 					  SPI_MEM_OP_DATA_OUT(1,
70 							spinand->scratchbuf,
71 							1));
72 
73 	*spinand->scratchbuf = target;
74 	return spi_mem_exec_op(spinand->spimem, &op);
75 }
76 
77 static const struct spinand_info winbond_spinand_table[] = {
78 	SPINAND_INFO("W25M02GV", 0xAB,
79 		     NAND_MEMORG(1, 2048, 64, 64, 1024, 1, 1, 2),
80 		     NAND_ECCREQ(1, 512),
81 		     SPINAND_INFO_OP_VARIANTS(&read_cache_variants,
82 					      &write_cache_variants,
83 					      &update_cache_variants),
84 		     0,
85 		     SPINAND_ECCINFO(&w25m02gv_ooblayout, NULL),
86 		     SPINAND_SELECT_TARGET(w25m02gv_select_target)),
87 };
88 
89 /**
90  * winbond_spinand_detect - initialize device related part in spinand_device
91  * struct if it is a Winbond device.
92  * @spinand: SPI NAND device structure
93  */
94 static int winbond_spinand_detect(struct spinand_device *spinand)
95 {
96 	u8 *id = spinand->id.data;
97 	int ret;
98 
99 	/*
100 	 * Winbond SPI NAND read ID need a dummy byte,
101 	 * so the first byte in raw_id is dummy.
102 	 */
103 	if (id[1] != SPINAND_MFR_WINBOND)
104 		return 0;
105 
106 	ret = spinand_match_and_init(spinand, winbond_spinand_table,
107 				     ARRAY_SIZE(winbond_spinand_table), id[2]);
108 	if (ret)
109 		return ret;
110 
111 	return 1;
112 }
113 
114 static int winbond_spinand_init(struct spinand_device *spinand)
115 {
116 	struct nand_device *nand = spinand_to_nand(spinand);
117 	unsigned int i;
118 
119 	/*
120 	 * Make sure all dies are in buffer read mode and not continuous read
121 	 * mode.
122 	 */
123 	for (i = 0; i < nand->memorg.ntargets; i++) {
124 		spinand_select_target(spinand, i);
125 		spinand_upd_cfg(spinand, WINBOND_CFG_BUF_READ,
126 				WINBOND_CFG_BUF_READ);
127 	}
128 
129 	return 0;
130 }
131 
132 static const struct spinand_manufacturer_ops winbond_spinand_manuf_ops = {
133 	.detect = winbond_spinand_detect,
134 	.init = winbond_spinand_init,
135 };
136 
137 const struct spinand_manufacturer winbond_spinand_manufacturer = {
138 	.id = SPINAND_MFR_WINBOND,
139 	.name = "Winbond",
140 	.ops = &winbond_spinand_manuf_ops,
141 };
142