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