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