p2p_i.h revision 8d520ff1dc2da35cdca849e982051b86468016d8
1/*
2 * P2P - Internal definitions for P2P module
3 * Copyright (c) 2009-2010, Atheros Communications
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
8 *
9 * Alternatively, this software may be distributed under the terms of BSD
10 * license.
11 *
12 * See README and COPYING for more details.
13 */
14
15#ifndef P2P_I_H
16#define P2P_I_H
17
18#include "utils/list.h"
19#include "p2p.h"
20
21/* TODO: add removal of expired P2P device entries */
22
23enum p2p_go_state {
24	UNKNOWN_GO,
25	LOCAL_GO,
26	REMOTE_GO
27};
28
29/**
30 * struct p2p_device - P2P Device data (internal to P2P module)
31 */
32struct p2p_device {
33	struct dl_list list;
34	struct os_time last_seen;
35	int listen_freq;
36	int level;
37	enum p2p_wps_method wps_method;
38
39	struct p2p_peer_info info;
40
41	/*
42	 * If the peer was discovered based on an interface address (e.g., GO
43	 * from Beacon/Probe Response), the interface address is stored here.
44	 * p2p_device_addr must still be set in such a case to the unique
45	 * identifier for the P2P Device.
46	 */
47	u8 interface_addr[ETH_ALEN];
48
49	/*
50	 * P2P Device Address of the GO in whose group this P2P Device is a
51	 * client.
52	 */
53	u8 member_in_go_dev[ETH_ALEN];
54
55	/*
56	 * P2P Interface Address of the GO in whose group this P2P Device is a
57	 * client.
58	 */
59	u8 member_in_go_iface[ETH_ALEN];
60
61	int go_neg_req_sent;
62	enum p2p_go_state go_state;
63	u8 dialog_token;
64	u8 intended_addr[ETH_ALEN];
65
66	char country[3];
67	struct p2p_channels channels;
68	int oper_freq;
69	u8 oper_ssid[32];
70	size_t oper_ssid_len;
71
72	/**
73	 * req_config_methods - Pending provisioning discovery methods
74	 */
75	u16 req_config_methods;
76
77#define P2P_DEV_PROBE_REQ_ONLY BIT(0)
78#define P2P_DEV_REPORTED BIT(1)
79#define P2P_DEV_NOT_YET_READY BIT(2)
80#define P2P_DEV_SD_INFO BIT(3)
81#define P2P_DEV_SD_SCHEDULE BIT(4)
82#define P2P_DEV_PD_PEER_DISPLAY BIT(5)
83#define P2P_DEV_PD_PEER_KEYPAD BIT(6)
84#define P2P_DEV_USER_REJECTED BIT(7)
85#define P2P_DEV_PEER_WAITING_RESPONSE BIT(8)
86#define P2P_DEV_PREFER_PERSISTENT_GROUP BIT(9)
87#define P2P_DEV_WAIT_GO_NEG_RESPONSE BIT(10)
88#define P2P_DEV_WAIT_GO_NEG_CONFIRM BIT(11)
89#define P2P_DEV_GROUP_CLIENT_ONLY BIT(12)
90#define P2P_DEV_FORCE_FREQ BIT(13)
91#define P2P_DEV_PD_FOR_JOIN BIT(14)
92#define P2P_DEV_REPORTED_ONCE BIT(15)
93	unsigned int flags;
94
95	int status; /* enum p2p_status_code */
96	unsigned int wait_count;
97	unsigned int connect_reqs;
98	unsigned int invitation_reqs;
99
100	u16 ext_listen_period;
101	u16 ext_listen_interval;
102
103	u8 go_timeout;
104	u8 client_timeout;
105};
106
107struct p2p_sd_query {
108	struct p2p_sd_query *next;
109	u8 peer[ETH_ALEN];
110	int for_all_peers;
111	struct wpabuf *tlvs;
112};
113
114struct p2p_pending_action_tx {
115	unsigned int freq;
116	u8 dst[ETH_ALEN];
117	u8 src[ETH_ALEN];
118	u8 bssid[ETH_ALEN];
119	size_t len;
120	unsigned int wait_time;
121	/* Followed by len octets of the frame */
122};
123
124/**
125 * struct p2p_data - P2P module data (internal to P2P module)
126 */
127struct p2p_data {
128	/**
129	 * cfg - P2P module configuration
130	 *
131	 * This is included in the same memory allocation with the
132	 * struct p2p_data and as such, must not be freed separately.
133	 */
134	struct p2p_config *cfg;
135
136	/**
137	 * state - The current P2P state
138	 */
139	enum p2p_state {
140		/**
141		 * P2P_IDLE - Idle
142		 */
143		P2P_IDLE,
144
145		/**
146		 * P2P_SEARCH - Search (Device Discovery)
147		 */
148		P2P_SEARCH,
149
150		/**
151		 * P2P_CONNECT - Trying to start GO Negotiation
152		 */
153		P2P_CONNECT,
154
155		/**
156		 * P2P_CONNECT_LISTEN - Listen during GO Negotiation start
157		 */
158		P2P_CONNECT_LISTEN,
159
160		/**
161		 * P2P_GO_NEG - In GO Negotiation
162		 */
163		P2P_GO_NEG,
164
165		/**
166		 * P2P_LISTEN_ONLY - Listen only
167		 */
168		P2P_LISTEN_ONLY,
169
170		/**
171		 * P2P_WAIT_PEER_CONNECT - Waiting peer in List for GO Neg
172		 */
173		P2P_WAIT_PEER_CONNECT,
174
175		/**
176		 * P2P_WAIT_PEER_IDLE - Waiting peer idle for GO Neg
177		 */
178		P2P_WAIT_PEER_IDLE,
179
180		/**
181		 * P2P_SD_DURING_FIND - Service Discovery during find
182		 */
183		P2P_SD_DURING_FIND,
184
185		/**
186		 * P2P_PROVISIONING - Provisioning (during group formation)
187		 */
188		P2P_PROVISIONING,
189
190		/**
191		 * P2P_PD_DURING_FIND - Provision Discovery during find
192		 */
193		P2P_PD_DURING_FIND,
194
195		/**
196		 * P2P_INVITE - Trying to start Invite
197		 */
198		P2P_INVITE,
199
200		/**
201		 * P2P_INVITE_LISTEN - Listen during Invite
202		 */
203		P2P_INVITE_LISTEN,
204	} state;
205
206	/**
207	 * min_disc_int - minDiscoverableInterval
208	 */
209	int min_disc_int;
210
211	/**
212	 * max_disc_int - maxDiscoverableInterval
213	 */
214	int max_disc_int;
215
216	/**
217	 * devices - List of known P2P Device peers
218	 */
219	struct dl_list devices;
220
221	/**
222	 * go_neg_peer - Pointer to GO Negotiation peer
223	 */
224	struct p2p_device *go_neg_peer;
225
226	/**
227	 * invite_peer - Pointer to Invite peer
228	 */
229	struct p2p_device *invite_peer;
230
231	const u8 *invite_go_dev_addr;
232	u8 invite_go_dev_addr_buf[ETH_ALEN];
233
234	/**
235	 * sd_peer - Pointer to Service Discovery peer
236	 */
237	struct p2p_device *sd_peer;
238
239	/**
240	 * sd_query - Pointer to Service Discovery query
241	 */
242	struct p2p_sd_query *sd_query;
243
244	/* GO Negotiation data */
245
246	/**
247	 * intended_addr - Local Intended P2P Interface Address
248	 *
249	 * This address is used during group owner negotiation as the Intended
250	 * P2P Interface Address and the group interface will be created with
251	 * address as the local address in case of successfully completed
252	 * negotiation.
253	 */
254	u8 intended_addr[ETH_ALEN];
255
256	/**
257	 * go_intent - Local GO Intent to be used during GO Negotiation
258	 */
259	u8 go_intent;
260
261	/**
262	 * next_tie_breaker - Next tie-breaker value to use in GO Negotiation
263	 */
264	u8 next_tie_breaker;
265
266	/**
267	 * ssid - Selected SSID for GO Negotiation (if local end will be GO)
268	 */
269	u8 ssid[32];
270
271	/**
272	 * ssid_len - ssid length in octets
273	 */
274	size_t ssid_len;
275
276	/**
277	 * Regulatory class for own operational channel
278	 */
279	u8 op_reg_class;
280
281	/**
282	 * op_channel - Own operational channel
283	 */
284	u8 op_channel;
285
286	/**
287	 * channels - Own supported regulatory classes and channels
288	 *
289	 * List of supposerted channels per regulatory class. The regulatory
290	 * classes are defined in IEEE Std 802.11-2007 Annex J and the
291	 * numbering of the clases depends on the configured country code.
292	 */
293	struct p2p_channels channels;
294
295	enum p2p_pending_action_state {
296		P2P_NO_PENDING_ACTION,
297		P2P_PENDING_GO_NEG_REQUEST,
298		P2P_PENDING_GO_NEG_RESPONSE,
299		P2P_PENDING_GO_NEG_RESPONSE_FAILURE,
300		P2P_PENDING_GO_NEG_CONFIRM,
301		P2P_PENDING_SD,
302		P2P_PENDING_PD,
303		P2P_PENDING_INVITATION_REQUEST,
304		P2P_PENDING_INVITATION_RESPONSE,
305		P2P_PENDING_DEV_DISC_REQUEST,
306		P2P_PENDING_DEV_DISC_RESPONSE,
307		P2P_PENDING_GO_DISC_REQ
308	} pending_action_state;
309
310	unsigned int pending_listen_freq;
311	unsigned int pending_listen_sec;
312	unsigned int pending_listen_usec;
313
314	u8 dev_capab;
315
316	int in_listen;
317	int drv_in_listen;
318
319	/**
320	 * sd_queries - Pending service discovery queries
321	 */
322	struct p2p_sd_query *sd_queries;
323
324	/**
325	 * srv_update_indic - Service Update Indicator for local services
326	 */
327	u16 srv_update_indic;
328
329	struct wpabuf *sd_resp; /* Fragmented SD response */
330	u8 sd_resp_addr[ETH_ALEN];
331	u8 sd_resp_dialog_token;
332	size_t sd_resp_pos; /* Offset in sd_resp */
333	u8 sd_frag_id;
334
335	struct wpabuf *sd_rx_resp; /* Reassembled SD response */
336	u16 sd_rx_update_indic;
337
338	/* P2P Invitation data */
339	enum p2p_invite_role inv_role;
340	u8 inv_bssid[ETH_ALEN];
341	int inv_bssid_set;
342	u8 inv_ssid[32];
343	size_t inv_ssid_len;
344	u8 inv_sa[ETH_ALEN];
345	u8 inv_group_bssid[ETH_ALEN];
346	u8 *inv_group_bssid_ptr;
347	u8 inv_go_dev_addr[ETH_ALEN];
348	u8 inv_status;
349	int inv_op_freq;
350	int inv_persistent;
351
352	enum p2p_discovery_type find_type;
353	u8 last_prog_scan_class;
354	u8 last_prog_scan_chan;
355	int p2p_scan_running;
356	enum p2p_after_scan {
357		P2P_AFTER_SCAN_NOTHING,
358		P2P_AFTER_SCAN_LISTEN,
359		P2P_AFTER_SCAN_CONNECT
360	} start_after_scan;
361	u8 after_scan_peer[ETH_ALEN];
362	struct p2p_pending_action_tx *after_scan_tx;
363
364	/* Requested device types for find/search */
365	unsigned int num_req_dev_types;
366	u8 *req_dev_types;
367
368	struct p2p_group **groups;
369	size_t num_groups;
370
371	struct p2p_device *pending_client_disc_go;
372	u8 pending_client_disc_addr[ETH_ALEN];
373	u8 pending_dev_disc_dialog_token;
374	u8 pending_dev_disc_addr[ETH_ALEN];
375	int pending_dev_disc_freq;
376	unsigned int pending_client_disc_freq;
377
378	int ext_listen_only;
379	unsigned int ext_listen_period;
380	unsigned int ext_listen_interval;
381	unsigned int ext_listen_interval_sec;
382	unsigned int ext_listen_interval_usec;
383
384	u8 peer_filter[ETH_ALEN];
385
386	int cross_connect;
387
388	int best_freq_24;
389	int best_freq_5;
390	int best_freq_overall;
391
392	/**
393	 * wps_vendor_ext - WPS Vendor Extensions to add
394	 */
395	struct wpabuf *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
396};
397
398/**
399 * struct p2p_message - Parsed P2P message (or P2P IE)
400 */
401struct p2p_message {
402	struct wpabuf *p2p_attributes;
403	struct wpabuf *wps_attributes;
404
405	u8 dialog_token;
406
407	const u8 *capability;
408	const u8 *go_intent;
409	const u8 *status;
410	const u8 *listen_channel;
411	const u8 *operating_channel;
412	const u8 *channel_list;
413	u8 channel_list_len;
414	const u8 *config_timeout;
415	const u8 *intended_addr;
416	const u8 *group_bssid;
417	const u8 *invitation_flags;
418
419	const u8 *group_info;
420	size_t group_info_len;
421
422	const u8 *group_id;
423	size_t group_id_len;
424
425	const u8 *device_id;
426
427	const u8 *manageability;
428
429	const u8 *noa;
430	size_t noa_len;
431
432	const u8 *ext_listen_timing;
433
434	const u8 *minor_reason_code;
435
436	/* P2P Device Info */
437	const u8 *p2p_device_info;
438	size_t p2p_device_info_len;
439	const u8 *p2p_device_addr;
440	const u8 *pri_dev_type;
441	u8 num_sec_dev_types;
442	char device_name[33];
443	u16 config_methods;
444
445	/* WPS IE */
446	u16 dev_password_id;
447	u16 wps_config_methods;
448	const u8 *wps_pri_dev_type;
449	const u8 *wps_sec_dev_type_list;
450	size_t wps_sec_dev_type_list_len;
451	const u8 *wps_vendor_ext[P2P_MAX_WPS_VENDOR_EXT];
452	size_t wps_vendor_ext_len[P2P_MAX_WPS_VENDOR_EXT];
453	const u8 *manufacturer;
454	size_t manufacturer_len;
455	const u8 *model_name;
456	size_t model_name_len;
457	const u8 *model_number;
458	size_t model_number_len;
459	const u8 *serial_number;
460	size_t serial_number_len;
461
462	/* DS Parameter Set IE */
463	const u8 *ds_params;
464
465	/* SSID IE */
466	const u8 *ssid;
467};
468
469
470#define P2P_MAX_GROUP_ENTRIES 50
471
472struct p2p_group_info {
473	unsigned int num_clients;
474	struct p2p_client_info {
475		const u8 *p2p_device_addr;
476		const u8 *p2p_interface_addr;
477		u8 dev_capab;
478		u16 config_methods;
479		const u8 *pri_dev_type;
480		u8 num_sec_dev_types;
481		const u8 *sec_dev_types;
482		const char *dev_name;
483		size_t dev_name_len;
484	} client[P2P_MAX_GROUP_ENTRIES];
485};
486
487
488/* p2p_utils.c */
489int p2p_random(char *buf, size_t len);
490int p2p_channel_to_freq(const char *country, int reg_class, int channel);
491int p2p_freq_to_channel(const char *country, unsigned int freq, u8 *reg_class,
492			u8 *channel);
493void p2p_channels_intersect(const struct p2p_channels *a,
494			    const struct p2p_channels *b,
495			    struct p2p_channels *res);
496int p2p_channels_includes(const struct p2p_channels *channels, u8 reg_class,
497			  u8 channel);
498
499/* p2p_parse.c */
500int p2p_parse_p2p_ie(const struct wpabuf *buf, struct p2p_message *msg);
501int p2p_parse_ies(const u8 *data, size_t len, struct p2p_message *msg);
502int p2p_parse(const u8 *data, size_t len, struct p2p_message *msg);
503void p2p_parse_free(struct p2p_message *msg);
504int p2p_attr_text(struct wpabuf *data, char *buf, char *end);
505int p2p_group_info_parse(const u8 *gi, size_t gi_len,
506			 struct p2p_group_info *info);
507
508/* p2p_build.c */
509
510struct p2p_noa_desc {
511	u8 count_type;
512	u32 duration;
513	u32 interval;
514	u32 start_time;
515};
516
517/* p2p_group.c */
518const u8 * p2p_group_get_interface_addr(struct p2p_group *group);
519u8 p2p_group_presence_req(struct p2p_group *group,
520			  const u8 *client_interface_addr,
521			  const u8 *noa, size_t noa_len);
522
523
524void p2p_buf_add_action_hdr(struct wpabuf *buf, u8 subtype, u8 dialog_token);
525void p2p_buf_add_public_action_hdr(struct wpabuf *buf, u8 subtype,
526				   u8 dialog_token);
527u8 * p2p_buf_add_ie_hdr(struct wpabuf *buf);
528void p2p_buf_add_status(struct wpabuf *buf, u8 status);
529void p2p_buf_add_device_info(struct wpabuf *buf, struct p2p_data *p2p,
530			     struct p2p_device *peer);
531void p2p_buf_add_device_id(struct wpabuf *buf, const u8 *dev_addr);
532void p2p_buf_update_ie_hdr(struct wpabuf *buf, u8 *len);
533void p2p_buf_add_capability(struct wpabuf *buf, u8 dev_capab, u8 group_capab);
534void p2p_buf_add_go_intent(struct wpabuf *buf, u8 go_intent);
535void p2p_buf_add_listen_channel(struct wpabuf *buf, const char *country,
536				u8 reg_class, u8 channel);
537void p2p_buf_add_operating_channel(struct wpabuf *buf, const char *country,
538				   u8 reg_class, u8 channel);
539void p2p_buf_add_channel_list(struct wpabuf *buf, const char *country,
540			      struct p2p_channels *chan);
541void p2p_buf_add_config_timeout(struct wpabuf *buf, u8 go_timeout,
542				u8 client_timeout);
543void p2p_buf_add_intended_addr(struct wpabuf *buf, const u8 *interface_addr);
544void p2p_buf_add_group_bssid(struct wpabuf *buf, const u8 *bssid);
545void p2p_buf_add_group_id(struct wpabuf *buf, const u8 *dev_addr,
546			  const u8 *ssid, size_t ssid_len);
547void p2p_buf_add_invitation_flags(struct wpabuf *buf, u8 flags);
548void p2p_buf_add_noa(struct wpabuf *buf, u8 noa_index, u8 opp_ps, u8 ctwindow,
549		     struct p2p_noa_desc *desc1, struct p2p_noa_desc *desc2);
550void p2p_buf_add_ext_listen_timing(struct wpabuf *buf, u16 period,
551				   u16 interval);
552void p2p_buf_add_p2p_interface(struct wpabuf *buf, struct p2p_data *p2p);
553void p2p_build_wps_ie(struct p2p_data *p2p, struct wpabuf *buf, u16 pw_id,
554		      int all_attr);
555
556/* p2p_sd.c */
557struct p2p_sd_query * p2p_pending_sd_req(struct p2p_data *p2p,
558					 struct p2p_device *dev);
559void p2p_free_sd_queries(struct p2p_data *p2p);
560void p2p_rx_gas_initial_req(struct p2p_data *p2p, const u8 *sa,
561			    const u8 *data, size_t len, int rx_freq);
562void p2p_rx_gas_initial_resp(struct p2p_data *p2p, const u8 *sa,
563			     const u8 *data, size_t len, int rx_freq);
564void p2p_rx_gas_comeback_req(struct p2p_data *p2p, const u8 *sa,
565			     const u8 *data, size_t len, int rx_freq);
566void p2p_rx_gas_comeback_resp(struct p2p_data *p2p, const u8 *sa,
567			      const u8 *data, size_t len, int rx_freq);
568int p2p_start_sd(struct p2p_data *p2p, struct p2p_device *dev);
569
570/* p2p_go_neg.c */
571int p2p_peer_channels_check(struct p2p_data *p2p, struct p2p_channels *own,
572			    struct p2p_device *dev,
573			    const u8 *channel_list, size_t channel_list_len);
574void p2p_process_go_neg_req(struct p2p_data *p2p, const u8 *sa,
575			    const u8 *data, size_t len, int rx_freq);
576void p2p_process_go_neg_resp(struct p2p_data *p2p, const u8 *sa,
577			     const u8 *data, size_t len, int rx_freq);
578void p2p_process_go_neg_conf(struct p2p_data *p2p, const u8 *sa,
579			     const u8 *data, size_t len);
580int p2p_connect_send(struct p2p_data *p2p, struct p2p_device *dev);
581
582/* p2p_pd.c */
583void p2p_process_prov_disc_req(struct p2p_data *p2p, const u8 *sa,
584			       const u8 *data, size_t len, int rx_freq);
585void p2p_process_prov_disc_resp(struct p2p_data *p2p, const u8 *sa,
586				const u8 *data, size_t len);
587int p2p_send_prov_disc_req(struct p2p_data *p2p, struct p2p_device *dev,
588			   int join);
589
590/* p2p_invitation.c */
591void p2p_process_invitation_req(struct p2p_data *p2p, const u8 *sa,
592				const u8 *data, size_t len, int rx_freq);
593void p2p_process_invitation_resp(struct p2p_data *p2p, const u8 *sa,
594				 const u8 *data, size_t len);
595int p2p_invite_send(struct p2p_data *p2p, struct p2p_device *dev,
596		    const u8 *go_dev_addr);
597void p2p_invitation_req_cb(struct p2p_data *p2p, int success);
598void p2p_invitation_resp_cb(struct p2p_data *p2p, int success);
599
600/* p2p_dev_disc.c */
601void p2p_process_dev_disc_req(struct p2p_data *p2p, const u8 *sa,
602			      const u8 *data, size_t len, int rx_freq);
603void p2p_dev_disc_req_cb(struct p2p_data *p2p, int success);
604int p2p_send_dev_disc_req(struct p2p_data *p2p, struct p2p_device *dev);
605void p2p_dev_disc_resp_cb(struct p2p_data *p2p, int success);
606void p2p_process_dev_disc_resp(struct p2p_data *p2p, const u8 *sa,
607			       const u8 *data, size_t len);
608void p2p_go_disc_req_cb(struct p2p_data *p2p, int success);
609void p2p_process_go_disc_req(struct p2p_data *p2p, const u8 *da, const u8 *sa,
610			     const u8 *data, size_t len, int rx_freq);
611
612/* p2p.c */
613void p2p_set_state(struct p2p_data *p2p, int new_state);
614void p2p_set_timeout(struct p2p_data *p2p, unsigned int sec,
615		     unsigned int usec);
616void p2p_clear_timeout(struct p2p_data *p2p);
617void p2p_continue_find(struct p2p_data *p2p);
618struct p2p_device * p2p_add_dev_from_go_neg_req(struct p2p_data *p2p,
619						const u8 *addr,
620						struct p2p_message *msg);
621void p2p_add_dev_info(struct p2p_data *p2p, const u8 *addr,
622		      struct p2p_device *dev, struct p2p_message *msg);
623struct p2p_device * p2p_get_device(struct p2p_data *p2p, const u8 *addr);
624struct p2p_device * p2p_get_device_interface(struct p2p_data *p2p,
625					     const u8 *addr);
626void p2p_go_neg_failed(struct p2p_data *p2p, struct p2p_device *peer,
627		       int status);
628void p2p_go_complete(struct p2p_data *p2p, struct p2p_device *peer);
629int p2p_match_dev_type(struct p2p_data *p2p, struct wpabuf *wps);
630int dev_type_list_match(const u8 *dev_type, const u8 *req_dev_type[],
631			size_t num_req_dev_type);
632struct wpabuf * p2p_build_probe_resp_ies(struct p2p_data *p2p);
633void p2p_build_ssid(struct p2p_data *p2p, u8 *ssid, size_t *ssid_len);
634int p2p_send_action(struct p2p_data *p2p, unsigned int freq, const u8 *dst,
635		    const u8 *src, const u8 *bssid, const u8 *buf,
636		    size_t len, unsigned int wait_time);
637
638#endif /* P2P_I_H */
639