NTB: correct ntb_peer_spad_addr and ntb_peer_spad_read comment typos
PATCH 1/1 NTB: correct ntb_peer_spad_addr and ntb_peer_spad_read comment typos
The comment for ntb_peer_spad_addr and ntb_peer_spad_read incorrectly referred to peer doorbell register and local scratchpad register.
Signed-off-by Wesley Sheng <[email protected]>
--- include/linux/ntb.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
include/linux/ntb.h +2 -2
@@ -1351,7 +1351,7 @@ static inline int ntb_spad_write(struct ntb_dev *ntb, int sidx, u32 val)* @sidx: Scratchpad index. * @spad_addr: OUT - The address of the peer scratchpad register. * -* Return the address of the peer doorbell register. This may be used, for +* Return the address of the peer scratchpad register. This may be used, for * example, by drivers that offload memory copy operations to a dma engine. * * Return: Zero on success, otherwise an error number.
@@ -1373,7 +1373,7 @@ static inline int ntb_peer_spad_addr(struct ntb_dev *ntb, int pidx, int sidx,* * Read the peer scratchpad register, and return the value. * -* Return: The value of the local scratchpad register. +* Return: The value of the peer scratchpad register. */ static inline u32 ntb_peer_spad_read (struct ntb_dev *ntb,int pidx,int sidx) {
Signature · 1 line
2.16.2
Jon Mason
maintainerQuoted 5 lines · Wesley Sheng
The comment for
ntb_peer_spad_addrandntb_peer_spad_readincorrectly referred to peer doorbell register and local scratchpad register.Signed-off-by Wesley Sheng <[email protected]>
Pulled into the ntb branch
Thanks,
Jon
Quoted 29 lines
--- include/linux/ntb.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)include/linux/ntb.h +2
-2@@ -1351,7 +1351,7 @@ static inline int ntb_spad_write(struct ntb_dev *ntb, int sidx, u32 val)* @sidx: Scratchpad index. * @spad_addr: OUT - The address of the peer scratchpad register. * -* Return the address of the peer doorbell register. This may be used, for +* Return the address of the peer scratchpad register. This may be used, for * example, by drivers that offload memory copy operations to a dma engine. * * Return: Zero on success, otherwise an error number. @@ -1373,7 +1373,7 @@ static inline int ntb_peer_spad_addr(struct ntb_dev *ntb, int pidx, int sidx,* * Read the peer scratchpad register, and return the value. * -* Return: The value of the local scratchpad register. +* Return: The value of the peer scratchpad register. */ static inline u32 ntb_peer_spad_read (struct ntb_dev *ntb,int pidx,int sidx) {Signature · 1 line
2.16.2