diff options
author | Jon Paul Maloy <jon.maloy@ericsson.com> | 2013-12-10 23:45:40 -0500 |
---|---|---|
committer | David S. Miller <davem@davemloft.net> | 2013-12-11 00:17:42 -0500 |
commit | ef72a7e02a28adfd9d5d0d1de81c0b75f3823aa5 (patch) | |
tree | e267d1860382bd7f27c1b7d25be652eee0ac6471 /net/tipc/bearer.h | |
parent | 5702dbab687e19792102200b085108f00ab820c9 (diff) |
tipc: improve naming and comment consistency in media layer
struct 'tipc_media' represents the specific info that the media
layer adaptors (eth_media and ib_media) expose to the generic
bearer layer. We clarify this by improved commenting, and by giving
the 'media_list' array the more appropriate name 'media_info_array'.
There are no functional changes in this commit.
Signed-off-by: Ying Xue <ying.xue@windriver.com>
Reviewed-by: Paul Gortmaker <paul.gortmaker@windriver.com>
Signed-off-by: Jon Maloy <jon.maloy@ericsson.com>
Signed-off-by: David S. Miller <davem@davemloft.net>
Diffstat (limited to 'net/tipc/bearer.h')
-rw-r--r-- | net/tipc/bearer.h | 6 |
1 files changed, 3 insertions, 3 deletions
diff --git a/net/tipc/bearer.h b/net/tipc/bearer.h index 516af8c0577d..e50266aa4d10 100644 --- a/net/tipc/bearer.h +++ b/net/tipc/bearer.h | |||
@@ -73,14 +73,13 @@ struct tipc_media_addr { | |||
73 | struct tipc_bearer; | 73 | struct tipc_bearer; |
74 | 74 | ||
75 | /** | 75 | /** |
76 | * struct tipc_media - TIPC media information available to internal users | 76 | * struct tipc_media - Media specific info exposed to generic bearer layer |
77 | * @send_msg: routine which handles buffer transmission | 77 | * @send_msg: routine which handles buffer transmission |
78 | * @enable_media: routine which enables a media | 78 | * @enable_media: routine which enables a media |
79 | * @disable_media: routine which disables a media | 79 | * @disable_media: routine which disables a media |
80 | * @addr2str: routine which converts media address to string | 80 | * @addr2str: routine which converts media address to string |
81 | * @addr2msg: routine which converts media address to protocol message area | 81 | * @addr2msg: routine which converts media address to protocol message area |
82 | * @msg2addr: routine which converts media address from protocol message area | 82 | * @msg2addr: routine which converts media address from protocol message area |
83 | * @bcast_addr: media address used in broadcasting | ||
84 | * @priority: default link (and bearer) priority | 83 | * @priority: default link (and bearer) priority |
85 | * @tolerance: default time (in ms) before declaring link failure | 84 | * @tolerance: default time (in ms) before declaring link failure |
86 | * @window: default window (in packets) before declaring link congestion | 85 | * @window: default window (in packets) before declaring link congestion |
@@ -105,13 +104,14 @@ struct tipc_media { | |||
105 | }; | 104 | }; |
106 | 105 | ||
107 | /** | 106 | /** |
108 | * struct tipc_bearer - TIPC bearer structure | 107 | * struct tipc_bearer - Generic TIPC bearer structure |
109 | * @usr_handle: pointer to additional media-specific information about bearer | 108 | * @usr_handle: pointer to additional media-specific information about bearer |
110 | * @mtu: max packet size bearer can support | 109 | * @mtu: max packet size bearer can support |
111 | * @lock: spinlock for controlling access to bearer | 110 | * @lock: spinlock for controlling access to bearer |
112 | * @addr: media-specific address associated with bearer | 111 | * @addr: media-specific address associated with bearer |
113 | * @name: bearer name (format = media:interface) | 112 | * @name: bearer name (format = media:interface) |
114 | * @media: ptr to media structure associated with bearer | 113 | * @media: ptr to media structure associated with bearer |
114 | * @bcast_addr: media address used in broadcasting | ||
115 | * @priority: default link priority for bearer | 115 | * @priority: default link priority for bearer |
116 | * @window: default window size for bearer | 116 | * @window: default window size for bearer |
117 | * @tolerance: default link tolerance for bearer | 117 | * @tolerance: default link tolerance for bearer |