thunderbolt: Update xdomain.c function documentation

+33 -13

1 changed file

expand all

drivers

thunderbolt

xdomain.c

+33 -13

drivers/thunderbolt/xdomain.c

··· 160 160 * This can be used to send a XDomain response message to the other 161 161 * domain. No response for the message is expected. 162 162 * 163 - * Return: %0 in case of success and negative errno in case of failure 163 + * Return: %0 on success, negative errno otherwise. 164 164 */ 165 165 int tb_xdomain_response(struct tb_xdomain *xd, const void *response, 166 166 size_t size, enum tb_cfg_pkg_type type) ··· 212 212 * the other domain. The function waits until the response is received 213 213 * or when timeout triggers. Whichever comes first. 214 214 * 215 - * Return: %0 in case of success and negative errno in case of failure 215 + * Return: %0 on success, negative errno otherwise. 216 216 */ 217 217 int tb_xdomain_request(struct tb_xdomain *xd, const void *request, 218 218 size_t request_size, enum tb_cfg_pkg_type request_type, ··· 613 613 * messages. After this function is called the service driver needs to 614 614 * be able to handle calls to callback whenever a package with the 615 615 * registered protocol is received. 616 + * 617 + * Return: %0 on success, negative errno otherwise. 616 618 */ 617 619 int tb_register_protocol_handler(struct tb_protocol_handler *handler) 618 620 { ··· 879 877 * @drv: Driver to register 880 878 * 881 879 * Registers new service driver from @drv to the bus. 880 + * 881 + * Return: %0 on success, negative errno otherwise. 882 882 */ 883 883 int tb_register_service_driver(struct tb_service_driver *drv) 884 884 { ··· 1959 1955 * 1960 1956 * Allocates new XDomain structure and returns pointer to that. The 1961 1957 * object must be released by calling tb_xdomain_put(). 1958 + * 1959 + * Return: Pointer to &struct tb_xdomain, %NULL in case of failure. 1962 1960 */ 1963 1961 struct tb_xdomain *tb_xdomain_alloc(struct tb *tb, struct device *parent, 1964 1962 u64 route, const uuid_t *local_uuid, ··· 2097 2091 * to enable bonding by first enabling the port and waiting for the CL0 2098 2092 * state. 2099 2093 * 2100 - * Return: %0 in case of success and negative errno in case of error. 2094 + * Return: %0 on success, negative errno otherwise. 2101 2095 */ 2102 2096 int tb_xdomain_lane_bonding_enable(struct tb_xdomain *xd) 2103 2097 { ··· 2177 2171 * @xd: XDomain connection 2178 2172 * @hopid: Preferred HopID or %-1 for next available 2179 2173 * 2180 - * Returns allocated HopID or negative errno. Specifically returns 2181 - * %-ENOSPC if there are no more available HopIDs. Returned HopID is 2182 - * guaranteed to be within range supported by the input lane adapter. 2174 + * Returned HopID is guaranteed to be within range supported by the input 2175 + * lane adapter. 2183 2176 * Call tb_xdomain_release_in_hopid() to release the allocated HopID. 2177 + * 2178 + * Return: 2179 + * * Allocated HopID - On success. 2180 + * * %-ENOSPC - If there are no more available HopIDs. 2181 + * * Negative errno - Another error occurred. 2184 2182 */ 2185 2183 int tb_xdomain_alloc_in_hopid(struct tb_xdomain *xd, int hopid) 2186 2184 { ··· 2203 2193 * @xd: XDomain connection 2204 2194 * @hopid: Preferred HopID or %-1 for next available 2205 2195 * 2206 - * Returns allocated HopID or negative errno. Specifically returns 2207 - * %-ENOSPC if there are no more available HopIDs. Returned HopID is 2208 - * guaranteed to be within range supported by the output lane adapter. 2209 - * Call tb_xdomain_release_in_hopid() to release the allocated HopID. 2196 + * Returned HopID is guaranteed to be within range supported by the 2197 + * output lane adapter. 2198 + * Call tb_xdomain_release_out_hopid() to release the allocated HopID. 2199 + * 2200 + * Return: 2201 + * * Allocated HopID - On success. 2202 + * * %-ENOSPC - If there are no more available HopIDs. 2203 + * * Negative errno - Another error occurred. 2210 2204 */ 2211 2205 int tb_xdomain_alloc_out_hopid(struct tb_xdomain *xd, int hopid) 2212 2206 { ··· 2259 2245 * path. If a transmit or receive path is not needed, pass %-1 for those 2260 2246 * parameters. 2261 2247 * 2262 - * Return: %0 in case of success and negative errno in case of error 2248 + * Return: %0 on success, negative errno otherwise. 2263 2249 */ 2264 2250 int tb_xdomain_enable_paths(struct tb_xdomain *xd, int transmit_path, 2265 2251 int transmit_ring, int receive_path, ··· 2284 2270 * as path/ring parameter means don't care. Normally the callers should 2285 2271 * pass the same values here as they do when paths are enabled. 2286 2272 * 2287 - * Return: %0 in case of success and negative errno in case of error 2273 + * Return: %0 on success, negative errno otherwise. 2288 2274 */ 2289 2275 int tb_xdomain_disable_paths(struct tb_xdomain *xd, int transmit_path, 2290 2276 int transmit_ring, int receive_path, ··· 2349 2335 * to the bus (handshake is still in progress). 2350 2336 * 2351 2337 * The caller needs to hold @tb->lock. 2338 + * 2339 + * Return: Pointer to &struct tb_xdomain or %NULL if not found. 2352 2340 */ 2353 2341 struct tb_xdomain *tb_xdomain_find_by_uuid(struct tb *tb, const uuid_t *uuid) 2354 2342 { ··· 2380 2364 * to the bus (handshake is still in progress). 2381 2365 * 2382 2366 * The caller needs to hold @tb->lock. 2367 + * 2368 + * Return: Pointer to &struct tb_xdomain or %NULL if not found. 2383 2369 */ 2384 2370 struct tb_xdomain *tb_xdomain_find_by_link_depth(struct tb *tb, u8 link, 2385 2371 u8 depth) ··· 2411 2393 * to the bus (handshake is still in progress). 2412 2394 * 2413 2395 * The caller needs to hold @tb->lock. 2396 + * 2397 + * Return: Pointer to &struct tb_xdomain or %NULL if not found. 2414 2398 */ 2415 2399 struct tb_xdomain *tb_xdomain_find_by_route(struct tb *tb, u64 route) 2416 2400 { ··· 2511 2491 * notified so they can re-read properties of this host if they are 2512 2492 * interested. 2513 2493 * 2514 - * Return: %0 on success and negative errno on failure 2494 + * Return: %0 on success, negative errno otherwise. 2515 2495 */ 2516 2496 int tb_register_property_dir(const char *key, struct tb_property_dir *dir) 2517 2497 {

Configure Feed

Configure Feed