Re: [PATCH v2 05/28] Silicon/Maxim: Add comments in Ds1307RtcLib

["Leif Lindholm" <leif@nuviainc.com>]

On Fri, Mar 20, 2020 at 20:05:20 +0530, Pankaj Bansal wrote:
> From: Pankaj Bansal <pankaj.bansal@nxp.com>
> 
> Add comments to explain the register read and write operation
> on Ds1307. These comments have been referred from data sheet:
> 
> https://datasheets.maximintegrated.com/en/ds/DS1307.pdf
> 
> Signed-off-by: Pankaj Bansal <pankaj.bansal@nxp.com>

Reviewed-by: Leif Lindholm <leif@nuviainc.com>

> ---
>  Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c | 8 ++++++++
>  1 file changed, 8 insertions(+)
> 
> diff --git a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c
> index fd7a8696e405..444e01124811 100644
> --- a/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c
> +++ b/Silicon/Maxim/Library/Ds1307RtcLib/Ds1307RtcLib.c
> @@ -28,6 +28,11 @@ STATIC EFI_I2C_MASTER_PROTOCOL    *mI2cMaster;
>  
>  /**
>    Read RTC register.
> +  Data Read-Slave Transmitter Mode
> +
> +  <Slave Address> <Word Address (n)> <Slave Address> <Data(n)> <Data(n+1)> <Data(n+2)> <Data(n+X)>
> +
> +  The first byte is received and handled as in the slave receiver mode.
>  
>    @param  RtcRegAddr       Register offset of RTC to be read.
>  
> @@ -69,6 +74,9 @@ RtcRead (
>  
>  /**
>    Write RTC register.
> +  Data Write-Slave Receiver Mode
> +
> +  <Slave Address> <Word Address (n)> <Data(n)> <Data(n+1)> <Data(n+X)>
>  
>    @param  RtcRegAddr       Register offset of RTC to write.
>    @param  Val              Value to be written
> -- 
> 2.17.1
>