mtd: spi-nor: Add documentation for spi_nor_soft_reset()
authorPratyush Yadav <p.yadav@ti.com>
Tue, 11 May 2021 09:39:58 +0000 (15:09 +0530)
committerVignesh Raghavendra <vigneshr@ti.com>
Wed, 26 May 2021 16:17:34 +0000 (21:47 +0530)
commitccfb7cf18f9680958e76991c8f15562ff42f4bc9
tree187c547a4551fe8b4c1ff6cf0a1fb9881389d860
parent5c26d52c9e5c9a22d04b805470e1143716b69789
mtd: spi-nor: Add documentation for spi_nor_soft_reset()

Document what the function does and that it should only be used when it
is known that the device supports it. This will avoid unaware
programmers thinking that they can arbitrarily use it to reset the
device.

Suggested-by: Michael Walle <michael@walle.cc>
Signed-off-by: Pratyush Yadav <p.yadav@ti.com>
Signed-off-by: Vignesh Raghavendra <vigneshr@ti.com>
Reviewed-by: Michael Walle <michael@walle.cc>
drivers/mtd/spi-nor/core.c