[PATCH v2 1/1] pmdomain: renesas: rcar-sysc: Update description of chan_offs, chan_bit, isr_bit

[Ayman Chaudhry]

The descriptions of `rcar_sysc_area.chan_offs`,
`rcar_sysc_area.chan_bits`, and `rcar_sysc_area.isr_bit` do not clearly
document how these fields are used.

When `rcar_sysc_area.flags` is set to `PD_ALWAYS_ON` (i.e. `PD_NO_CR`),
these fields are ignored, therefore improve the description of
`rcar_sysc_area.chan_offs`, `rcar_sysc_area.chan_bit`, and
`rcar_sysc_area.isr_bit` to make it clear that the field is set to 0 if
power is always on.

Signed-off-by: Ayman Chaudhry <ayman.chaudhry.kc@xxxxxxxxxxx>
---
v1->v2:
- Updated commit title and message
- Changed the description of `rcar_sysc_area.chan_bit` and
  `rcar_sysc_area.isr_bit`

 drivers/pmdomain/renesas/rcar-sysc.h | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/drivers/pmdomain/renesas/rcar-sysc.h b/drivers/pmdomain/renesas/rcar-sysc.h
index 9e93a1f98f68..b264e727883b 100644
--- a/drivers/pmdomain/renesas/rcar-sysc.h
+++ b/drivers/pmdomain/renesas/rcar-sysc.h
@@ -29,9 +29,15 @@
 
 struct rcar_sysc_area {
 	const char *name;
-	u16 chan_offs;		/* Offset of PWRSR register for this area */
-	u8 chan_bit;		/* Bit in PWR* (except for PWRUP in PWRSR) */
-	u8 isr_bit;		/* Bit in SYSCI*R */
+	u16 chan_offs;		/*
+				 * PWRSR register offset; or 0 if area is
+				 * always on
+				 */
+	u8 chan_bit;		/*
+				 * Bit in PWR* (except for PWRUP in PWRSR);
+				 * 0 if area is always on
+				 */
+	u8 isr_bit;		/* Bit in SYSCI*R; 0 if area is always on */
 	s8 parent;		/* -1 if none */
 	u8 flags;		/* See PD_* */
 };
-- 
2.34.1