Received-SPF: pass (google.com: best guess record for domain of linux-kernel-owner@vger.kernel.org designates 209.132.180.67 as permitted sender) client-ip=209.132.180.67;
Received-SPF: Pass (esa5.microchip.iphmx.com: domain of
  Tudor.Ambarus@microchip.com designates 198.175.253.82 as
  permitted sender) identity=mailfrom;
  client-ip=198.175.253.82; receiver=esa5.microchip.iphmx.com;
  envelope-from="Tudor.Ambarus@microchip.com";
  x-sender="Tudor.Ambarus@microchip.com";
  x-conformance=spf_only; x-record-type="v=spf1";
  x-record-text="v=spf1 mx a:ushub1.microchip.com
  a:smtpout.microchip.com a:mx1.microchip.iphmx.com
  a:mx2.microchip.iphmx.com include:servers.mcsv.net
  include:mktomail.com include:spf.protection.outlook.com ~all"
Received-SPF: None (esa5.microchip.iphmx.com: no sender
  authenticity information available from domain of
  postmaster@email.microchip.com) identity=helo;
  client-ip=198.175.253.82; receiver=esa5.microchip.iphmx.com;
  envelope-from="Tudor.Ambarus@microchip.com";
  x-sender="postmaster@email.microchip.com";
  x-conformance=spf_only
IronPort-SDR: RwLcJLpr/EaDDKiioYSWMIrxGeR3XlRqbU+BjqViVV42SUkt23T7sn6iLAPYlhVgzJhmy78d4t
 mljdQDQeMtB2brM25Af3ir3TRQOZ07U/Ikt3k43wkqVyCEnoVA5lGyo65sHgwamehcYlb1yFlJ
 TYI8+d4nGfkTdZR6DZ3J9uz5dpQN9aIEsNIfzukqk1eFqzOcekIoV+dTRj7lTziUfGHZdAXpAE
 eLz4qPyjt7AOoMMPWXngnmm1P4xAWZynnMeIbSM1Pzk/V18e8UPGRY4eMyc+BxQimGIPh7EuyH
 3do=
From:   <Tudor.Ambarus@microchip.com>
To:     <boris.brezillon@collabora.com>, <marek.vasut@gmail.com>,
        <vigneshr@ti.com>
CC:     <dwmw2@infradead.org>, <computersforpeace@gmail.com>,
        <miquel.raynal@bootlin.com>, <richard@nod.at>,
        <linux-mtd@lists.infradead.org>, <linux-kernel@vger.kernel.org>,
        <boris.brezillon@bootlin.com>, <Tudor.Ambarus@microchip.com>
Subject: [PATCH 3/6] mtd: spi-nor: Add a ->convert_addr() method
Thread-Topic: [PATCH 3/6] mtd: spi-nor: Add a ->convert_addr() method
Thread-Index: AQHVR4AJ8T1LlMyH1UObdz4atBEwIQ==
Date:   Wed, 31 Jul 2019 09:12:12 +0000
Message-ID: <20190731091145.27374-4-tudor.ambarus@microchip.com>
References: <20190731091145.27374-1-tudor.ambarus@microchip.com>
In-Reply-To: <20190731091145.27374-1-tudor.ambarus@microchip.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-messagesentrepresentingtype: 1
x-mailer: git-send-email 2.9.5
x-originating-ip: [94.177.32.154]
x-ms-publictraffictype: Email
x-ms-office365-filtering-correlation-id: 4348bc61-8ef4-4294-c0a0-08d715972c4a
x-microsoft-antispam: BCL:0;PCL:0;RULEID:(2390118)(7020095)(4652040)(8989299)(4534185)(4627221)(201703031133081)(201702281549075)(8990200)(5600148)(711020)(4605104)(1401327)(2017052603328)(7193020);SRVR:MN2PR11MB4414;
x-ms-traffictypediagnostic: MN2PR11MB4414:
x-microsoft-antispam-prvs: <MN2PR11MB44147B5713EA9D52F8F2365BF0DF0@MN2PR11MB4414.namprd11.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:10000;
x-forefront-prvs: 011579F31F
x-forefront-antispam-report: SFV:NSPM;SFS:(10009020)(366004)(136003)(396003)(39860400002)(376002)(346002)(199004)(189003)(14454004)(26005)(81166006)(6116002)(50226002)(76176011)(5660300002)(66066001)(2501003)(6512007)(25786009)(486006)(102836004)(107886003)(2201001)(110136005)(305945005)(3846002)(7736002)(68736007)(53936002)(6486002)(478600001)(86362001)(71200400001)(71190400001)(14444005)(186003)(476003)(256004)(8936002)(6436002)(7416002)(386003)(52116002)(54906003)(316002)(66946007)(81156014)(11346002)(2616005)(2906002)(64756008)(4326008)(446003)(99286004)(36756003)(66556008)(8676002)(66476007)(66446008)(1076003)(6506007);DIR:OUT;SFP:1101;SCL:1;SRVR:MN2PR11MB4414;H:MN2PR11MB4448.namprd11.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;A:1;MX:1;
received-spf: None (protection.outlook.com: microchip.com does not designate
 permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam-message-info: qKX38Amk+5xLjWWMTzhwwAL0iLvUu/GYbn3Er2TQ7W+h1BhlcfGhhOTvUqnkDESuK8++ng2jHyq2tk5ykKeB5oNX9A/BRmYFAnB1NcLBgPBPT4dS6T1jWlysQWuW8OlOqdwYNBxRbjRRFJT+dq1zfSTgbYAeZF6QJB0w8ZF/sqasYP0/1opmkd8RUAtKlKeikNonMxNwZgMpswitqRdr0AL1ici1758FYhjRxOvxfBAKg6Ayuwu4F1LrlS23es9L8Cnp4HjVZzzvJvuIoiB1mqKiVCboqC2vqwXYQte6Iv2U+AVWKAU959sh+L2o3jaNESB4k2siKVgZyCv5Hc0nCT+tZbaFS4Sv4YfkD2uc5CTE0ay173R1yh4/7I7G4grw2R2VCeDGpBAfxVieU0/nBXe3Zmfh6znnBQ6QBnXMMBM=
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-MS-Exchange-CrossTenant-Network-Message-Id: 4348bc61-8ef4-4294-c0a0-08d715972c4a
X-MS-Exchange-CrossTenant-originalarrivaltime: 31 Jul 2019 09:12:12.4726
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 3f4057f3-b418-4d4e-ba84-d55b4e897d88
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: tudor.ambarus@microchip.com
X-MS-Exchange-Transport-CrossTenantHeadersStamped: MN2PR11MB4414
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

From: Boris Brezillon <boris.brezillon@bootlin.com>

In order to separate manufacturer quirks from the core we need to get
rid of all the manufacturer specific flags, like the
SNOR_F_S3AN_ADDR_DEFAULT one.

This can easily be replaced by a ->convert_addr() hook, which when
implemented will provide the core with an easy way to convert an
absolute address into something the flash understands.

Right now the only user are the S3AN chips, but other manufacturers
can implement it if needed.

Signed-off-by: Boris Brezillon <boris.brezillon@bootlin.com>
Signed-off-by: Tudor Ambarus <tudor.ambarus@microchip.com>
---
 drivers/mtd/spi-nor/spi-nor.c | 24 ++++++++++++++----------
 include/linux/mtd/spi-nor.h   | 15 +++++++++------
 2 files changed, 23 insertions(+), 16 deletions(-)

diff --git a/drivers/mtd/spi-nor/spi-nor.c b/drivers/mtd/spi-nor/spi-nor.c
index 30f9d524e72f..3b6810d76a79 100644
--- a/drivers/mtd/spi-nor/spi-nor.c
+++ b/drivers/mtd/spi-nor/spi-nor.c
@@ -1045,10 +1045,9 @@ static void spi_nor_unlock_and_unprep(struct spi_nor=
 *nor, enum spi_nor_ops ops)
  * Addr can safely be unsigned int, the biggest S3AN device is smaller tha=
n
  * 4 MiB.
  */
-static loff_t spi_nor_s3an_addr_convert(struct spi_nor *nor, unsigned int =
addr)
+static u32 s3an_convert_addr(struct spi_nor *nor, u32 addr)
 {
-	unsigned int offset;
-	unsigned int page;
+	u32 offset, page;
=20
 	offset =3D addr % nor->page_size;
 	page =3D addr / nor->page_size;
@@ -1057,6 +1056,14 @@ static loff_t spi_nor_s3an_addr_convert(struct spi_n=
or *nor, unsigned int addr)
 	return page | offset;
 }
=20
+static u32 spi_nor_convert_addr(struct spi_nor *nor, loff_t addr)
+{
+	if (!nor->convert_addr)
+		return addr;
+
+	return nor->convert_addr(nor, addr);
+}
+
 /*
  * Initiate the erasure of a single sector
  */
@@ -1065,8 +1072,7 @@ static int spi_nor_erase_sector(struct spi_nor *nor, =
u32 addr)
 	u8 buf[SPI_NOR_MAX_ADDR_WIDTH];
 	int i;
=20
-	if (nor->flags & SNOR_F_S3AN_ADDR_DEFAULT)
-		addr =3D spi_nor_s3an_addr_convert(nor, addr);
+	addr =3D spi_nor_convert_addr(nor, addr);
=20
 	if (nor->erase)
 		return nor->erase(nor, addr);
@@ -2675,8 +2681,7 @@ static int spi_nor_read(struct mtd_info *mtd, loff_t =
from, size_t len,
 	while (len) {
 		loff_t addr =3D from;
=20
-		if (nor->flags & SNOR_F_S3AN_ADDR_DEFAULT)
-			addr =3D spi_nor_s3an_addr_convert(nor, addr);
+		addr =3D spi_nor_convert_addr(nor, addr);
=20
 		ret =3D spi_nor_read_data(nor, addr, len, buf);
 		if (ret =3D=3D 0) {
@@ -2820,8 +2825,7 @@ static int spi_nor_write(struct mtd_info *mtd, loff_t=
 to, size_t len,
 		page_remain =3D min_t(size_t,
 				    nor->page_size - page_offset, len - i);
=20
-		if (nor->flags & SNOR_F_S3AN_ADDR_DEFAULT)
-			addr =3D spi_nor_s3an_addr_convert(nor, addr);
+		addr =3D spi_nor_convert_addr(nor, addr);
=20
 		write_enable(nor);
 		ret =3D spi_nor_write_data(nor, addr, page_remain, buf + i);
@@ -2889,7 +2893,7 @@ static int s3an_nor_scan(struct spi_nor *nor)
 		nor->mtd.erasesize =3D 8 * nor->page_size;
 	} else {
 		/* Flash in Default addressing mode */
-		nor->flags |=3D SNOR_F_S3AN_ADDR_DEFAULT;
+		nor->convert_addr =3D s3an_convert_addr;
 	}
=20
 	return 0;
diff --git a/include/linux/mtd/spi-nor.h b/include/linux/mtd/spi-nor.h
index 185ca11bfb63..af04d3117188 100644
--- a/include/linux/mtd/spi-nor.h
+++ b/include/linux/mtd/spi-nor.h
@@ -238,12 +238,11 @@ enum spi_nor_option_flags {
 	SNOR_F_USE_FSR		=3D BIT(0),
 	SNOR_F_HAS_SR_TB	=3D BIT(1),
 	SNOR_F_NO_OP_CHIP_ERASE	=3D BIT(2),
-	SNOR_F_S3AN_ADDR_DEFAULT =3D BIT(3),
-	SNOR_F_READY_XSR_RDY	=3D BIT(4),
-	SNOR_F_USE_CLSR		=3D BIT(5),
-	SNOR_F_BROKEN_RESET	=3D BIT(6),
-	SNOR_F_4B_OPCODES	=3D BIT(7),
-	SNOR_F_HAS_4BAIT	=3D BIT(8),
+	SNOR_F_READY_XSR_RDY	=3D BIT(3),
+	SNOR_F_USE_CLSR		=3D BIT(4),
+	SNOR_F_BROKEN_RESET	=3D BIT(5),
+	SNOR_F_4B_OPCODES	=3D BIT(6),
+	SNOR_F_HAS_4BAIT	=3D BIT(7),
 };
=20
 /**
@@ -380,6 +379,9 @@ struct flash_info;
  * @quad_enable:	[FLASH-SPECIFIC] enables SPI NOR quad mode
  * @set_4byte:		[FLASH-SPECIFIC] puts the SPI NOR in 4 byte addressing
  *                      mode
+ * @convert_addr:	[FLASH-SPECIFIC] convert an absolute address into
+ *                      something the flash will understand. Particularly
+ *                      useful when pagesize is not a power-of-2
  * @disable_write_protection: [FLASH-SPECIFIC] disable write protection du=
ring
  *                            power-up
  *			completely locked
@@ -423,6 +425,7 @@ struct spi_nor {
 	int (*flash_is_locked)(struct spi_nor *nor, loff_t ofs, uint64_t len);
 	int (*quad_enable)(struct spi_nor *nor);
 	int (*set_4byte)(struct spi_nor *nor, bool enable);
+	u32 (*convert_addr)(struct spi_nor *nor, u32 addr);
 	int (*disable_write_protection)(struct spi_nor *nor);
=20
 	const struct spi_nor_locking_ops *locking_ops;
--=20
2.9.5