workbench/devs/networks/realtek8180/device.h

   1 /*
   2
   3 Copyright (C) 2001-2017 Neil Cafferkey
   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 as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful, but
  11 WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  13 General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  18 MA 02111-1307, USA.
  19
  20 */
  21
  22 #ifndef DEVICE_H
  23 #define DEVICE_H
  24
  25
  26 #include <exec/types.h>
  27 #include <exec/devices.h>
  28 #include <exec/interrupts.h>
  29 #include <exec/semaphores.h>
  30 #include <devices/sana2.h>
  31 #include <devices/sana2specialstats.h>
  32 #include <devices/sana2wireless.h>
  33 #include <devices/timer.h>
  34
  35 #include "wireless.h"
  36 #include "io.h"
  37
  38 #define DEVICE_NAME "realtek8180.device"
  39 #define VERSION 0
  40 #define REVISION 5
  41 #define DATE "7.7.2017"
  42
  43 #define UTILITY_VERSION 39
  44 #define POSEIDON_VERSION 0
  45
  46 #ifndef UPINT
  47 #ifdef __AROS__
  48 typedef IPTR UPINT;
  49 typedef SIPTR PINT;
  50 #else
  51 typedef ULONG UPINT;
  52 typedef LONG PINT;
  53 #endif
  54 #endif
  55
  56 #ifndef REG
  57 #if defined(__mc68000) && !defined(__AROS__)
  58 #define _REG(A, B) B __asm(#A)
  59 #define REG(A, B) _REG(A, B)
  60 #else
  61 #define REG(A, B) B
  62 #endif
  63 #endif
  64
  65 #define _STR(A) #A
  66 #define STR(A) _STR(A)
  67
  68 #ifdef __AROS__
  69 #include <aros/debug.h>
  70 #define DebugPrintF kprintf
  71 #endif
  72
  73 #ifndef __AROS__
  74 #define USE_HACKS
  75 #endif
  76
  77
  78 struct DevBase
  79 {
  80    struct Device device;
  81    APTR seg_list;
  82    struct ExecBase *sys_base;
  83    struct UtilityBase *utility_base;
  84    struct Library *poseidon_base;
  85    struct MinList usb_units;
  86    struct timerequest timer_request;
  87 #ifdef __amigaos4__
  88    struct Library *expansion_base;
  89    struct ExecIFace *i_exec;
  90    struct UtilityIFace *i_utility;
  91    struct PCIIFace *i_pci;
  92    struct TimerIFace *i_timer;
  93 #endif
  94    VOID (*wrapper_int_code)();
  95 };
  96
  97
  98 enum
  99 {
 100    WRITE_QUEUE,
 101    MGMT_QUEUE,
 102    ADOPT_QUEUE,
 103    EVENT_QUEUE,
 104    SCAN_QUEUE,
 105    GENERAL_QUEUE,
 106    REQUEST_QUEUE_COUNT
 107 };
 108
 109 enum
 110 {
 111    PCI_BUS,
 112    USB_BUS,
 113 };
 114
 115 enum
 116 {
 117    RTL8187L_GEN,
 118    RTL8187B0_GEN,
 119    RTL8187B1_GEN,
 120    RTL8187B2_GEN,
 121 };
 122
 123 enum
 124 {
 125    RTL8225_RADIO,
 126    RTL8225V2_RADIO,
 127    RTL8225V2B_RADIO,
 128 };
 129
 130 #define ETH_ADDRESSSIZE 6
 131 #define ETH_HEADERSIZE 14
 132 #define ETH_MTU 1500
 133 #define ETH_MAXPACKETSIZE (ETH_HEADERSIZE + ETH_MTU)
 134
 135 #define ETH_PACKET_DEST 0
 136 #define ETH_PACKET_SOURCE 6
 137 #define ETH_PACKET_TYPE 12
 138 #define ETH_PACKET_IEEELEN 12
 139 #define ETH_PACKET_DATA 14
 140
 141 #define SNAP_HEADERSIZE 8
 142
 143 #define SNAP_FRM_TYPE 6
 144
 145 #define CHANNEL_COUNT 14
 146
 147 #define IV_SIZE 4
 148 #define EIV_SIZE 8
 149 #define ICV_SIZE 4
 150 #define MIC_SIZE 8
 151
 152 #define STAT_COUNT 3
 153 #define ENC_COUNT 4
 154
 155 #define FRAME_BUFFER_SIZE (WIFI_FRM_DATA + SNAP_HEADERSIZE \
 156    + ETH_MTU + EIV_SIZE + ICV_SIZE + MIC_SIZE)
 157 #define FRAME_BUFFER_COUNT 10
 158 #define TX_SLOT_COUNT 30
 159 #define RX_SLOT_COUNT 30
 160
 161
 162 struct KeyUnion
 163 {
 164    UWORD type;
 165    union
 166    {
 167       struct WEPKey
 168       {
 169          UWORD length;
 170          UBYTE key[13];
 171          ULONG tx_iv;
 172       }
 173       wep;
 174       struct TKIPKey
 175       {
 176          UWORD key[8];
 177          ULONG tx_mic_key[2];
 178          ULONG rx_mic_key[2];
 179          UWORD tx_iv_low;
 180          ULONG tx_iv_high;
 181          UWORD rx_iv_low;
 182          ULONG rx_iv_high;
 183          UWORD tx_ttak[5];
 184          BOOL tx_ttak_set;
 185          UWORD rx_ttak[5];
 186          BOOL rx_ttak_set;
 187       }
 188       tkip;
 189       struct CCMPKey
 190       {
 191          UBYTE key[16];
 192          BOOL stream_set;
 193          ULONG stream[44];
 194          UWORD tx_iv_low;
 195          ULONG tx_iv_high;
 196          UWORD rx_iv_low;
 197          ULONG rx_iv_high;
 198       }
 199       ccmp;
 200    }
 201    u;
 202 };
 203
 204
 205 struct DevUnit
 206 {
 207    struct MinNode node;
 208    ULONG index;
 209    ULONG open_count;
 210    ULONG flags;
 211    UWORD bus;
 212    UWORD generation;
 213    UWORD eeprom_addr_size;
 214    UWORD radio_type;
 215    struct Task *task;
 216    struct MsgPort *request_ports[REQUEST_QUEUE_COUNT];
 217    struct DevBase *device;
 218    APTR card;
 219    BOOL (*insertion_function)(APTR, struct DevBase *);
 220    VOID (*removal_function)(APTR, struct DevBase *);
 221    ULONG (*ByteIn)(APTR, ULONG);
 222    VOID (*ByteOut)(APTR, ULONG, UBYTE);
 223    UWORD (*LEWordIn)(APTR, ULONG);
 224    ULONG (*LELongIn)(APTR, ULONG);
 225    VOID (*LEWordOut)(APTR, ULONG, UWORD);
 226    VOID (*LELongOut)(APTR, ULONG, ULONG);
 227    VOID (*SendFrame)(APTR, APTR, ULONG);
 228    VOID (*ReceiveFrame)(APTR, APTR, ULONG);
 229    APTR (*AllocDMAMem)(APTR, UPINT, UWORD);
 230    VOID (*FreeDMAMem)(APTR, APTR);
 231    UBYTE *tx_buffer;
 232    UBYTE *tx_buffers[TX_SLOT_COUNT];
 233    UBYTE *rx_buffer;
 234    UBYTE *rx_buffers[RX_SLOT_COUNT];
 235    UBYTE *rx_frames;
 236    LONG rx_fragment_nos[FRAME_BUFFER_COUNT];
 237    ULONG card_removed_signal;
 238    ULONG card_inserted_signal;
 239    ULONG range_count;
 240    UBYTE address[ETH_ADDRESSSIZE];
 241    UBYTE default_address[ETH_ADDRESSSIZE];
 242    UBYTE bssid[ETH_ADDRESSSIZE + 2];
 243    struct MinList openers;
 244    struct MinList type_trackers;
 245    struct MinList multicast_ranges;
 246    struct Interrupt rx_int;
 247    struct Interrupt tx_int;
 248    struct Interrupt mgmt_int;
 249    struct Sana2DeviceStats stats;
 250    ULONG special_stats[STAT_COUNT];
 251    UBYTE *tx_descs[TX_SLOT_COUNT];
 252    UBYTE *rx_descs[RX_SLOT_COUNT];
 253    struct IOSana2Req **tx_requests;
 254    ULONG speed;
 255    struct Sana2SignalQuality signal_quality;
 256    struct SignalSemaphore access_lock;
 257    UWORD tx_in_slot;
 258    UWORD tx_out_slot;
 259    UWORD rx_slot;
 260    UWORD mode;
 261    UWORD band;
 262    UWORD channel;
 263    UBYTE base_cck_power;
 264    UBYTE base_ofdm_power;
 265    UBYTE cck_power[CHANNEL_COUNT + 1];
 266    UBYTE ofdm_power[CHANNEL_COUNT + 1];
 267    UWORD assoc_id;
 268    UWORD capabilities;
 269    UWORD tx_rate;
 270    UWORD mgmt_rate;
 271    UWORD tx_rate_code;
 272    UWORD mgmt_rate_code;
 273    UWORD tx_sequence;
 274    UWORD tx_key_no;
 275    struct KeyUnion keys[WIFI_KEYCOUNT];
 276    UWORD iv_sizes[ENC_COUNT];
 277    VOID (*fragment_encrypt_functions[ENC_COUNT])(struct DevUnit *, UBYTE *,
 278       UBYTE *, UWORD *, UBYTE *, struct DevBase *);
 279    BOOL (*fragment_decrypt_functions[ENC_COUNT])(struct DevUnit *, UBYTE *,
 280       UBYTE *, UWORD *, UBYTE *, struct DevBase *);
 281    UWORD retries_offset;
 282    UWORD tx_desc_size;
 283    UWORD rx_desc_size;
 284 };
 285
 286
 287 struct Opener
 288 {
 289    struct MinNode node;
 290    struct MsgPort read_port;
 291    struct MsgPort mgmt_port;
 292    BOOL (*rx_function)(REG(a0, APTR), REG(a1, APTR), REG(d0, ULONG));
 293    BOOL (*tx_function)(REG(a0, APTR), REG(a1, APTR), REG(d0, ULONG));
 294    UBYTE *(*dma_tx_function)(REG(a0, APTR));
 295    struct Hook *filter_hook;
 296    struct MinList initial_stats;
 297 #if defined(__amigaos4__) || defined(__MORPHOS__) || defined(__AROS__)
 298    const VOID *real_rx_function;
 299    const VOID *real_tx_function;
 300    const VOID *real_dma_tx_function;
 301 #endif
 302 };
 303
 304
 305 struct TypeStats
 306 {
 307    struct MinNode node;
 308    ULONG packet_type;
 309    struct Sana2PacketTypeStats stats;
 310 };
 311
 312
 313 struct TypeTracker
 314 {
 315    struct MinNode node;
 316    ULONG packet_type;
 317    struct Sana2PacketTypeStats stats;
 318    ULONG user_count;
 319 };
 320
 321
 322 struct AddressRange
 323 {
 324    struct MinNode node;
 325    ULONG add_count;
 326    ULONG lower_bound_left;
 327    ULONG upper_bound_left;
 328    UWORD lower_bound_right;
 329    UWORD upper_bound_right;
 330 };
 331
 332
 333 /* Unit flags */
 334
 335 #define UNITF_SHARED (1 << 0)
 336 #define UNITF_ONLINE (1 << 1)
 337 #define UNITF_HAVEADAPTER (1 << 2)
 338 #define UNITF_CONFIGURED (1 << 3)
 339 #define UNITF_PROM (1 << 4)
 340 #define UNITF_WASONLINE (1 << 5)   /* card was online at time of removal */
 341 #define UNITF_HARDWEP (1 << 6)
 342 #define UNITF_HARDTKIP (1 << 7)
 343 #define UNITF_HARDCCMP (1 << 8)
 344 #define UNITF_ALLMCAST (1 << 9)
 345 #define UNITF_HASADHOC (1 << 10)
 346 #define UNITF_SHORTPREAMBLE (1 << 11)
 347 #define UNITF_INTADDED (1 << 12)
 348 #define UNITF_RESETADDED (1 << 13)
 349 #define UNITF_TASKADDED (1 << 14)
 350
 351
 352 /* Endianness macros */
 353
 354 #define FlipWord(A) \
 355    ({ \
 356       UWORD _FlipWord_A = (A); \
 357       _FlipWord_A = (_FlipWord_A << 8) | (_FlipWord_A >> 8); \
 358    })
 359
 360 #define FlipLong(A) \
 361    ({ \
 362       ULONG _FlipLong_A = (A); \
 363       _FlipLong_A = \
 364          (FlipWord(_FlipLong_A) << 16) | FlipWord(_FlipLong_A >> 16); \
 365    })
 366
 367 #define FlipQuad(A) \
 368    ({ \
 369       UQUAD _FlipQuad_A = (A); \
 370       _FlipQuad_A = \
 371          (FlipLong(_FlipQuad_A) << 32) | FlipLong(_FlipQuad_A >> 32); \
 372    })
 373
 374 #ifndef __i386__ /* Big endian */
 375
 376 #define BEWord(A) \
 377    (A)
 378
 379 #define BELong(A) \
 380    (A)
 381
 382 #define LEWord(A) \
 383    FlipWord(A)
 384
 385 #define LELong(A) \
 386    FlipLong(A)
 387
 388 #define LEQuad(A) \
 389    FlipQuad(A)
 390
 391 #else
 392
 393 #define BEWord(A) \
 394    FlipWord(A)
 395
 396 #define BELong(A) \
 397    FlipLong(A)
 398
 399 #define LEWord(A) \
 400    (A)
 401
 402 #define LELong(A) \
 403    (A)
 404
 405 #define LEQuad(A) \
 406    (A)
 407
 408 #endif
 409
 410 #define MakeBEWord(A) \
 411    BEWord(A)
 412
 413 #define MakeBELong(A) \
 414    BELong(A)
 415
 416 #define MakeLEWord(A) \
 417    LEWord(A)
 418
 419 #define MakeLELong(A) \
 420    LELong(A)
 421
 422
 423 /* Library and device bases */
 424
 425 #define SysBase (base->sys_base)
 426 #define UtilityBase (base->utility_base)
 427 #define PsdBase (base->poseidon_base)
 428 #define TimerBase (base->timer_request.tr_node.io_Device)
 429
 430 #ifdef __amigaos4__
 431 #define IExec (base->i_exec)
 432 #define IUtility (base->i_utility)
 433 #define ITimer (base->i_timer)
 434 #endif
 435
 436 #ifdef __AROS__
 437 #define ps PsdBase
 438 #endif
 439
 440 #ifndef BASE_REG
 441 #define BASE_REG a6
 442 #endif
 443
 444
 445 #endif