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;
From:   Peng Fan <peng.fan@nxp.com>
To:     "gregkh@linuxfoundation.org" <gregkh@linuxfoundation.org>,
        "jslaby@suse.com" <jslaby@suse.com>
CC:     "linux-serial@vger.kernel.org" <linux-serial@vger.kernel.org>,
        "linux-kernel@vger.kernel.org" <linux-kernel@vger.kernel.org>,
        dl-linux-imx <linux-imx@nxp.com>, Peng Fan <peng.fan@nxp.com>
Subject: [PATCH] tty: serial: pch_uart: correct usage of dma_unmap_sg
Thread-Topic: [PATCH] tty: serial: pch_uart: correct usage of dma_unmap_sg
Thread-Index: AQHVmeR4JqxDQDN/nUWmBR6Ye0wD+Q==
Date:   Wed, 13 Nov 2019 05:37:42 +0000
Message-ID: <1573623259-6339-1-git-send-email-peng.fan@nxp.com>
Accept-Language: en-US
Content-Language: en-US
x-ms-exchange-messagesentrepresentingtype: 1
x-originating-ip: [119.31.174.66]
x-ms-publictraffictype: Email
x-ms-office365-filtering-ht: Tenant
x-ms-office365-filtering-correlation-id: 00b42073-9f51-49b5-4974-08d767fb9acd
x-ms-traffictypediagnostic: DB7PR04MB5209:|DB7PR04MB5209:
x-ms-exchange-transport-forked: True
x-microsoft-antispam-prvs: <DB7PR04MB5209D4AE714FC6E2A576D1F488760@DB7PR04MB5209.eurprd04.prod.outlook.com>
x-ms-oob-tlc-oobclassifiers: OLM:4502;
x-forefront-prvs: 0220D4B98D
x-forefront-antispam-report: SFV:NSPM;SFS:(10009020)(4636009)(136003)(346002)(366004)(39860400002)(376002)(396003)(189003)(199004)(386003)(66946007)(36756003)(6436002)(110136005)(26005)(50226002)(316002)(66556008)(6116002)(66476007)(3846002)(64756008)(66446008)(6506007)(25786009)(99286004)(186003)(66066001)(102836004)(2906002)(44832011)(52116002)(54906003)(86362001)(14444005)(6512007)(486006)(71200400001)(2616005)(476003)(71190400001)(5660300002)(478600001)(14454004)(8676002)(6486002)(4326008)(81156014)(81166006)(7736002)(305945005)(8936002)(256004)(2501003);DIR:OUT;SFP:1101;SCL:1;SRVR:DB7PR04MB5209;H:DB7PR04MB4490.eurprd04.prod.outlook.com;FPR:;SPF:None;LANG:en;PTR:InfoNoRecords;MX:1;A:1;
received-spf: None (protection.outlook.com: nxp.com does not designate
 permitted sender hosts)
x-ms-exchange-senderadcheck: 1
x-microsoft-antispam: BCL:0;
x-microsoft-antispam-message-info: 0DaytV1m6f2J4zBFmtkr3+dzV+PoxKDEHRgwv5AjuSLXBtNGR+adyKWj8CnYJvChY+GwFzVwN7viJO6m5jBOwtTs2v2l8aEQrDtVmQAv488NdFZwGspECjWbKjsVyVGuniTjp4FW6csWVOWHvmD7zeTvy/qL+g/4ToVZSbdJo8VX36DPfTuFPSYcjGgPePM86Lt88mpAFHs+J6zBIRq0RYoGHfBblBCMb24QwYjbQUgSiR/o33gzAP9NBoWRNBfQcFjaFkBEprxYFKvZTrZZwFCB78bR6EDNLllYPRFBp4R94Lbn4lfV8hMksIJebbsix9sHAuof2BBXESfirfBjVdFSOtG4jVOPvqSvmA5gtzPiDqFdOJFmmBbHBwTZYbsHqZkNkovOqt5LP9UdIH4f3FrlakMFtETdUPnA+rQsrUZisutm2OgQBzwLyuxr28GQ
Content-Type: text/plain; charset="iso-8859-1"
Content-Transfer-Encoding: quoted-printable
MIME-Version: 1.0
X-OriginatorOrg: nxp.com
X-MS-Exchange-CrossTenant-Network-Message-Id: 00b42073-9f51-49b5-4974-08d767fb9acd
X-MS-Exchange-CrossTenant-originalarrivaltime: 13 Nov 2019 05:37:43.0310
 (UTC)
X-MS-Exchange-CrossTenant-fromentityheader: Hosted
X-MS-Exchange-CrossTenant-id: 686ea1d3-bc2b-4c6f-a92c-d99c5c301635
X-MS-Exchange-CrossTenant-mailboxtype: HOSTED
X-MS-Exchange-CrossTenant-userprincipalname: B0p/lUoEFRMeI5h2tAB3wwRmu/3q21SptO093O+/zU43tWlOWigibkf2CqnMt4feYZ7l4vJHn6SGzqegzS/7Mw==
X-MS-Exchange-Transport-CrossTenantHeadersStamped: DB7PR04MB5209
Sender: linux-kernel-owner@vger.kernel.org
Precedence: bulk
List-ID: <linux-kernel.vger.kernel.org>
X-Mailing-List: linux-kernel@vger.kernel.org

Per Documentation/DMA-API-HOWTO.txt,
To unmap a scatterlist, just call:
	dma_unmap_sg(dev, sglist, nents, direction);

.. note::

	The 'nents' argument to the dma_unmap_sg call must be
	the _same_ one you passed into the dma_map_sg call,
	it should _NOT_ be the 'count' value _returned_ from the
	dma_map_sg call.

However in the driver, priv->nent is directly assigned with value
returned from dma_map_sg, and dma_unmap_sg use priv->nent for unmap,
this breaks the API usage.

So introduce a new entry orig_nent to remember 'nents'.

Fixes: da3564ee027e("pch_uart: add multi-scatter processing")
Signed-off-by: Peng Fan <peng.fan@nxp.com>
---

V1:
 Code inspection, not tested.

 drivers/tty/serial/pch_uart.c | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

diff --git a/drivers/tty/serial/pch_uart.c b/drivers/tty/serial/pch_uart.c
index 6157213a8359..c16234bca78f 100644
--- a/drivers/tty/serial/pch_uart.c
+++ b/drivers/tty/serial/pch_uart.c
@@ -233,6 +233,7 @@ struct eg20t_port {
 	struct dma_chan			*chan_rx;
 	struct scatterlist		*sg_tx_p;
 	int				nent;
+	int				orig_nent;
 	struct scatterlist		sg_rx;
 	int				tx_dma_use;
 	void				*rx_buf_virt;
@@ -787,9 +788,10 @@ static void pch_dma_tx_complete(void *arg)
 	}
 	xmit->tail &=3D UART_XMIT_SIZE - 1;
 	async_tx_ack(priv->desc_tx);
-	dma_unmap_sg(port->dev, sg, priv->nent, DMA_TO_DEVICE);
+	dma_unmap_sg(port->dev, sg, priv->orig_nent, DMA_TO_DEVICE);
 	priv->tx_dma_use =3D 0;
 	priv->nent =3D 0;
+	priv->orig_nent =3D 0;
 	kfree(priv->sg_tx_p);
 	pch_uart_hal_enable_interrupt(priv, PCH_UART_HAL_TX_INT);
 }
@@ -1010,6 +1012,7 @@ static unsigned int dma_handle_tx(struct eg20t_port *=
priv)
 		dev_err(priv->port.dev, "%s:dma_map_sg Failed\n", __func__);
 		return 0;
 	}
+	priv->orig_nent =3D num;
 	priv->nent =3D nent;
=20
 	for (i =3D 0; i < nent; i++, sg++) {
--=20
2.16.4