git.sur5r.net Git - ngadmin/blob - lib/ngadmin.h

   1
   2 #ifndef DEF_NGADMIN
   3 #define DEF_NGADMIN
   4
   5
   6 #include <stdbool.h>
   7 #include <arpa/inet.h>
   8 #include <netinet/ether.h>
   9
  10
  11 #ifdef BUILD_LIB
  12 #define EXPORT  __attribute__((visibility("default")))
  13 #else
  14 #define EXPORT
  15 #endif
  16
  17
  18 #define ERR_OK          0       // no error
  19 #define ERR_NET         -1      // network
  20 #define ERR_NOTLOG      -2      // not logged on a switch
  21 #define ERR_BADPASS     -3      // bad password
  22 #define ERR_BADID       -4      // bad switch id
  23 #define ERR_INVARG      -5      // invalid argument
  24 #define ERR_TIMEOUT     -6      // timeout
  25
  26 #define PRODUCT_SIZE    64
  27 #define NAME_SIZE       64
  28 #define FIRMWARE_SIZE   64
  29
  30
  31
  32
  33 #define SPEED_DOWN              0
  34 #define SPEED_10                1
  35 #define SPEED_100               4
  36 #define SPEED_1000              5
  37
  38 #define VLAN_PORT_BASIC         1
  39 #define VLAN_PORT_ADV           2
  40 #define VLAN_DOT_BASIC          3
  41 #define VLAN_DOT_ADV            4
  42
  43 #define QOS_PORT                1
  44 #define QOS_DOT                 2
  45
  46 #define PRIO_HIGH               1
  47 #define PRIO_MED                2
  48 #define PRIO_NORM               3
  49 #define PRIO_LOW                4
  50
  51 #define BITRATE_NOLIMIT         0
  52 #define BITRATE_512K            1
  53 #define BITRATE_1M              2
  54 #define BITRATE_2M              3
  55 #define BITRATE_4M              4
  56 #define BITRATE_8M              5
  57 #define BITRATE_16M             6
  58 #define BITRATE_32M             7
  59 #define BITRATE_64M             8
  60 #define BITRATE_128M            9
  61 #define BITRATE_256M            10
  62 #define BITRATE_512M            11
  63
  64
  65
  66
  67 // opaque type to clients
  68 struct ngadmin;
  69
  70
  71 struct net_conf {
  72  struct in_addr ip;             // IP
  73  struct in_addr netmask;        // netmask
  74  struct in_addr gw;             // gateway IP
  75  bool dhcp;                     // DHCP enabled
  76 };
  77
  78
  79 struct swi_attr {
  80  char product[PRODUCT_SIZE];    // product name (eg. GS108E)
  81  char name[NAME_SIZE];          // custom name
  82  char firmware[FIRMWARE_SIZE];  // firmware version string
  83  unsigned char ports;           // number of ports
  84  struct ether_addr mac;         // MAC address
  85  struct net_conf nc;            // network configuration
  86 };
  87
  88
  89 struct port_stats {
  90  unsigned long long recv;
  91  unsigned long long sent;
  92  unsigned long long crc;
  93 };
  94
  95
  96
  97
  98 // initialize NgAdmin lib
  99 struct ngadmin* ngadmin_init (const char *iface) EXPORT;
 100
 101 //
 102 int ngadmin_close (struct ngadmin *nga) EXPORT;
 103
 104
 105 // specify password to use for authenticating on switches
 106 int ngadmin_setPassword (struct ngadmin *nga, const char *pass) EXPORT;
 107
 108
 109 //
 110 int ngadmin_setTimeout (struct ngadmin *nga, const struct timeval *tv) EXPORT;
 111
 112
 113 //
 114 int ngadmin_scan (struct ngadmin *nga) EXPORT;
 115
 116
 117 //
 118 const struct swi_attr* ngadmin_getSwitchTab (struct ngadmin *nga, int *nb) EXPORT;
 119
 120
 121 //
 122 const struct swi_attr* ngadmin_getCurrentSwitch (struct ngadmin *nga) EXPORT;
 123
 124
 125 //
 126 int ngadmin_login (struct ngadmin *nga, int id) EXPORT;
 127
 128
 129 //
 130 int ngadmin_getPortsStatus (struct ngadmin *nga, unsigned char *ports) EXPORT;
 131
 132
 133 //
 134 int ngadmin_setName (struct ngadmin *nga, const char *name) EXPORT;
 135
 136
 137 //
 138 int ngadmin_getPortsStatistics (struct ngadmin *nga, struct port_stats *ps) EXPORT;
 139
 140
 141 //
 142 int ngadmin_resetPortsStatistics (struct ngadmin *nga) EXPORT;
 143
 144
 145 //
 146 int ngadmin_changePassword (struct ngadmin *nga, const char* pass) EXPORT;
 147
 148
 149
 150 #endif
 151