Commit a7c23237 authored by Allen Hubbe's avatar Allen Hubbe Committed by Jon Mason

NTB: Fix documentation for ntb_link_is_up

There was a copy and paste error in the documentation for
ntb_link_is_up.  The long description was mistakenly copied from
ntb_link_set_trans.

This adds the appropriate long description for ntb_link_is_up.
Reported-by: default avatarDave Jiang <dave.jiang@intel.com>
Signed-off-by: default avatarAllen Hubbe <Allen.Hubbe@emc.com>
Signed-off-by: default avatarJon Mason <jdmason@kudzu.us>
parent 569410ca
...@@ -522,10 +522,9 @@ static inline int ntb_mw_clear_trans(struct ntb_dev *ntb, int idx) ...@@ -522,10 +522,9 @@ static inline int ntb_mw_clear_trans(struct ntb_dev *ntb, int idx)
* @speed: OUT - The link speed expressed as PCIe generation number. * @speed: OUT - The link speed expressed as PCIe generation number.
* @width: OUT - The link width expressed as the number of PCIe lanes. * @width: OUT - The link width expressed as the number of PCIe lanes.
* *
* Set the translation of a memory window. The peer may access local memory * Get the current state of the ntb link. It is recommended to query the link
* through the window starting at the address, up to the size. The address * state once after every link event. It is safe to query the link state in
* must be aligned to the alignment specified by ntb_mw_get_range(). The size * the context of the link event callback.
* must be aligned to the size alignment specified by ntb_mw_get_range().
* *
* Return: One if the link is up, zero if the link is down, otherwise a * Return: One if the link is up, zero if the link is down, otherwise a
* negative value indicating the error number. * negative value indicating the error number.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment