lib/lacp.h

   1 /*
   2  * Copyright (c) 2011 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef LACP_H
  18 #define LACP_H 1
  19
  20 #include <stdbool.h>
  21 #include <stdint.h>
  22 #include "packets.h"
  23
  24 /* LACP Protocol Implementation. */
  25
  26 enum lacp_time {
  27     LACP_TIME_FAST,
  28     LACP_TIME_SLOW,
  29     LACP_TIME_CUSTOM
  30 };
  31
  32 struct lacp_settings {
  33     char *name;
  34     uint8_t id[ETH_ADDR_LEN];
  35     uint16_t priority;
  36     bool active;
  37     enum lacp_time lacp_time;
  38     long long int custom_time;
  39     bool heartbeat;
  40 };
  41
  42 void lacp_init(void);
  43 struct lacp *lacp_create(void);
  44 void lacp_destroy(struct lacp *);
  45
  46 void lacp_configure(struct lacp *, const struct lacp_settings *);
  47 bool lacp_is_active(const struct lacp *);
  48
  49 void lacp_process_packet(struct lacp *, const void *slave,
  50                          const struct ofpbuf *packet);
  51 bool lacp_negotiated(const struct lacp *);
  52
  53 struct lacp_slave_settings {
  54     char *name;
  55     uint16_t id;
  56     uint16_t priority;
  57     uint16_t key;
  58 };
  59
  60 void lacp_slave_register(struct lacp *, void *slave_,
  61                          const struct lacp_slave_settings *);
  62 void lacp_slave_unregister(struct lacp *, const void *slave);
  63 void lacp_slave_carrier_changed(const struct lacp *, const void *slave);
  64 bool lacp_slave_may_enable(const struct lacp *, const void *slave);
  65 uint16_t lacp_slave_get_port_id(const struct lacp *, const void *slave);
  66 bool lacp_slave_is_current(const struct lacp *, const void *slave_);
  67
  68 /* Callback function for lacp_run() for sending a LACP PDU. */
  69 typedef void lacp_send_pdu(void *slave, const void *pdu, size_t pdu_size);
  70
  71 void lacp_run(struct lacp *, lacp_send_pdu *);
  72 void lacp_wait(struct lacp *);
  73
  74 #endif /* lacp.h */