xiaomi-sm8450/android_kernel_xiaomi_sm8450
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: connector: convert to ReST and rename to connector.rst

Browse Source 
As it has some function definitions, move them to connector.h.

The remaining conversion is actually:
  - add blank lines and identation in order to identify paragraphs;
  - fix tables markups;
  - add some lists markups;
  - mark literal blocks;
  - adjust title markups.

At its new index.rst, let's add a :orphan: while this is not linked to
the main index.rst file, in order to avoid build warnings.

Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
This commit is contained in:
Mauro Carvalho Chehab
2019-04-13 22:54:53 -03:00
parent 387b14684f
commit 720594f691
4 changed files with 109 additions and 88 deletions
Download Patch File Download Diff File Expand all files Collapse all files

63
include/linux/connector.h
View File

@@ -55,10 +55,71 @@ struct cn_dev {
struct cn_queue_dev *cbdev;
};
/**
* cn_add_callback() - Registers new callback with connector core.
*
* @id: unique connector's user identifier.
* It must be registered in connector.h for legal
* in-kernel users.
* @name: connector's callback symbolic name.
* @callback: connector's callback.
* parameters are %cn_msg and the sender's credentials
*/
int cn_add_callback(struct cb_id *id, const char *name,
void (*callback)(struct cn_msg *, struct netlink_skb_parms *));
void cn_del_callback(struct cb_id *);
/**
* cn_del_callback() - Unregisters new callback with connector core.
*
* @id: unique connector's user identifier.
*/
void cn_del_callback(struct cb_id *id);
/**
* cn_netlink_send_mult - Sends message to the specified groups.
*
* @msg: message header(with attached data).
* @len: Number of @msg to be sent.
* @portid: destination port.
* If non-zero the message will be sent to the given port,
* which should be set to the original sender.
* @group: destination group.
* If @portid and @group is zero, then appropriate group will
* be searched through all registered connector users, and
* message will be delivered to the group which was created
* for user with the same ID as in @msg.
* If @group is not zero, then message will be delivered
* to the specified group.
* @gfp_mask: GFP mask.
*
* It can be safely called from softirq context, but may silently
* fail under strong memory pressure.
*
* If there are no listeners for given group %-ESRCH can be returned.
*/
int cn_netlink_send_mult(struct cn_msg *msg, u16 len, u32 portid, u32 group, gfp_t gfp_mask);
/**
* cn_netlink_send_mult - Sends message to the specified groups.
*
* @msg: message header(with attached data).
* @portid: destination port.
* If non-zero the message will be sent to the given port,
* which should be set to the original sender.
* @group: destination group.
* If @portid and @group is zero, then appropriate group will
* be searched through all registered connector users, and
* message will be delivered to the group which was created
* for user with the same ID as in @msg.
* If @group is not zero, then message will be delivered
* to the specified group.
* @gfp_mask: GFP mask.
*
* It can be safely called from softirq context, but may silently
* fail under strong memory pressure.
*
* If there are no listeners for given group %-ESRCH can be returned.
*/
int cn_netlink_send(struct cn_msg *msg, u32 portid, u32 group, gfp_t gfp_mask);
int cn_queue_add_callback(struct cn_queue_dev *dev, const char *name,