xref: /OK3568_Linux_fs/kernel/drivers/w1/w1_internal.h (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0-or-later */
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  * Copyright (c) 2004 Evgeniy Polyakov <zbr@ioremap.net>
4*4882a593Smuzhiyun  */
5*4882a593Smuzhiyun 
6*4882a593Smuzhiyun #ifndef __W1_H
7*4882a593Smuzhiyun #define __W1_H
8*4882a593Smuzhiyun 
9*4882a593Smuzhiyun #include <linux/w1.h>
10*4882a593Smuzhiyun 
11*4882a593Smuzhiyun #include <linux/completion.h>
12*4882a593Smuzhiyun #include <linux/mutex.h>
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #define W1_SLAVE_ACTIVE		0
15*4882a593Smuzhiyun #define W1_SLAVE_DETACH		1
16*4882a593Smuzhiyun 
17*4882a593Smuzhiyun /**
18*4882a593Smuzhiyun  * struct w1_async_cmd - execute callback from the w1_process kthread
19*4882a593Smuzhiyun  * @async_entry: link entry
20*4882a593Smuzhiyun  * @cb: callback function, must list_del and destroy this list before
21*4882a593Smuzhiyun  * returning
22*4882a593Smuzhiyun  *
23*4882a593Smuzhiyun  * When inserted into the w1_master async_list, w1_process will execute
24*4882a593Smuzhiyun  * the callback.  Embed this into the structure with the command details.
25*4882a593Smuzhiyun  */
26*4882a593Smuzhiyun struct w1_async_cmd {
27*4882a593Smuzhiyun 	struct list_head	async_entry;
28*4882a593Smuzhiyun 	void (*cb)(struct w1_master *dev, struct w1_async_cmd *async_cmd);
29*4882a593Smuzhiyun };
30*4882a593Smuzhiyun 
31*4882a593Smuzhiyun int w1_create_master_attributes(struct w1_master *master);
32*4882a593Smuzhiyun void w1_destroy_master_attributes(struct w1_master *master);
33*4882a593Smuzhiyun void w1_search(struct w1_master *dev, u8 search_type,
34*4882a593Smuzhiyun 	       w1_slave_found_callback cb);
35*4882a593Smuzhiyun void w1_search_devices(struct w1_master *dev, u8 search_type,
36*4882a593Smuzhiyun 		       w1_slave_found_callback cb);
37*4882a593Smuzhiyun /* call w1_unref_slave to release the reference counts w1_search_slave added */
38*4882a593Smuzhiyun struct w1_slave *w1_search_slave(struct w1_reg_num *id);
39*4882a593Smuzhiyun /*
40*4882a593Smuzhiyun  * decrements the reference on sl->master and sl, and cleans up if zero
41*4882a593Smuzhiyun  * returns the reference count after it has been decremented
42*4882a593Smuzhiyun  */
43*4882a593Smuzhiyun int w1_unref_slave(struct w1_slave *sl);
44*4882a593Smuzhiyun void w1_slave_found(struct w1_master *dev, u64 rn);
45*4882a593Smuzhiyun void w1_search_process_cb(struct w1_master *dev, u8 search_type,
46*4882a593Smuzhiyun 			  w1_slave_found_callback cb);
47*4882a593Smuzhiyun struct w1_slave *w1_slave_search_device(struct w1_master *dev,
48*4882a593Smuzhiyun 					struct w1_reg_num *rn);
49*4882a593Smuzhiyun struct w1_master *w1_search_master_id(u32 id);
50*4882a593Smuzhiyun 
51*4882a593Smuzhiyun /* Disconnect and reconnect devices in the given family.  Used for finding
52*4882a593Smuzhiyun  * unclaimed devices after a family has been registered or releasing devices
53*4882a593Smuzhiyun  * after a family has been unregistered.  Set attach to 1 when a new family
54*4882a593Smuzhiyun  * has just been registered, to 0 when it has been unregistered.
55*4882a593Smuzhiyun  */
56*4882a593Smuzhiyun void w1_reconnect_slaves(struct w1_family *f, int attach);
57*4882a593Smuzhiyun int w1_attach_slave_device(struct w1_master *dev, struct w1_reg_num *rn);
58*4882a593Smuzhiyun /* 0 success, otherwise EBUSY */
59*4882a593Smuzhiyun int w1_slave_detach(struct w1_slave *sl);
60*4882a593Smuzhiyun 
61*4882a593Smuzhiyun void __w1_remove_master_device(struct w1_master *dev);
62*4882a593Smuzhiyun 
63*4882a593Smuzhiyun void w1_family_put(struct w1_family *f);
64*4882a593Smuzhiyun void __w1_family_get(struct w1_family *f);
65*4882a593Smuzhiyun struct w1_family *w1_family_registered(u8 fid);
66*4882a593Smuzhiyun 
67*4882a593Smuzhiyun extern struct device_driver w1_master_driver;
68*4882a593Smuzhiyun extern struct device w1_master_device;
69*4882a593Smuzhiyun extern int w1_max_slave_count;
70*4882a593Smuzhiyun extern int w1_max_slave_ttl;
71*4882a593Smuzhiyun extern struct list_head w1_masters;
72*4882a593Smuzhiyun extern struct mutex w1_mlock;
73*4882a593Smuzhiyun extern spinlock_t w1_flock;
74*4882a593Smuzhiyun 
75*4882a593Smuzhiyun int w1_process_callbacks(struct w1_master *dev);
76*4882a593Smuzhiyun int w1_process(void *data);
77*4882a593Smuzhiyun 
78*4882a593Smuzhiyun #endif /* __W1_H */
79