src/p2p/p2p_i.h

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