diff options
| author | Allen Hubbe <Allen.Hubbe@emc.com> | 2015-07-15 04:15:28 -0400 |
|---|---|---|
| committer | Jon Mason <jdmason@kudzu.us> | 2015-09-07 15:17:09 -0400 |
| commit | a7c23237481782fbea3c2230e362b72863e144b0 (patch) | |
| tree | 3b88291ab1fc59fcafb85871f107a7aab6b00156 /include/linux/ntb.h | |
| parent | 569410ca756cd3ebb15609cb6828a8393fb6384d (diff) | |
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: Dave Jiang <dave.jiang@intel.com>
Signed-off-by: Allen Hubbe <Allen.Hubbe@emc.com>
Signed-off-by: Jon Mason <jdmason@kudzu.us>
Diffstat (limited to 'include/linux/ntb.h')
| -rw-r--r-- | include/linux/ntb.h | 7 |
1 files changed, 3 insertions, 4 deletions
diff --git a/include/linux/ntb.h b/include/linux/ntb.h index b02f72bb8e32..e3d3299c6052 100644 --- a/include/linux/ntb.h +++ b/include/linux/ntb.h @@ -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. * @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 - * through the window starting at the address, up to the size. The address - * must be aligned to the alignment specified by ntb_mw_get_range(). The size - * must be aligned to the size alignment specified by ntb_mw_get_range(). + * Get the current state of the ntb link. It is recommended to query the link + * state once after every link event. It is safe to query the link state in + * the context of the link event callback. * * Return: One if the link is up, zero if the link is down, otherwise a * negative value indicating the error number. |