kaweth.c 30.8 KB
Newer Older
Linus Torvalds's avatar
Linus Torvalds committed
1 2 3 4 5 6 7
/****************************************************************
 *
 *     kaweth.c - driver for KL5KUSB101 based USB->Ethernet
 *
 *     (c) 2000 Interlan Communications
 *     (c) 2000 Stephane Alnet
 *     (C) 2001 Brad Hards
8
 *     (C) 2002 Oliver Neukum
Linus Torvalds's avatar
Linus Torvalds committed
9 10
 *
 *     Original author: The Zapman <zapman@interlan.net>
11
 *     Inspired by, and much credit goes to Michael Rothwell
Linus Torvalds's avatar
Linus Torvalds committed
12 13
 *     <rothwell@interlan.net> for the test equipment, help, and patience
 *     Based off of (and with thanks to) Petko Manolov's pegaus.c driver.
14
 *     Also many thanks to Joel Silverman and Ed Surprenant at Kawasaki
Linus Torvalds's avatar
Linus Torvalds committed
15 16 17 18
 *     for providing the firmware and driver resources.
 *
 *     This program is free software; you can redistribute it and/or
 *     modify it under the terms of the GNU General Public License as
19
 *     published by the Free Software Foundation; either version 2, or
Linus Torvalds's avatar
Linus Torvalds committed
20 21 22 23 24 25 26 27 28
 *     (at your option) any later version.
 *
 *     This program is distributed in the hope that it will be useful,
 *     but WITHOUT ANY WARRANTY; without even the implied warranty of
 *     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *     GNU General Public License for more details.
 *
 *     You should have received a copy of the GNU General Public License
 *     along with this program; if not, write to the Free Software Foundation,
29
 *     Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
Linus Torvalds's avatar
Linus Torvalds committed
30 31 32 33 34 35 36 37 38 39
 *
 ****************************************************************/

/* TODO:
 * Fix in_interrupt() problem
 * Develop test procedures for USB net interfaces
 * Run test procedures
 * Fix bugs from previous two steps
 * Snoop other OSs for any tricks we're not doing
 * SMP locking
40 41
 * Reduce arbitrary timeouts
 * Smart multicast support
Linus Torvalds's avatar
Linus Torvalds committed
42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
 * Temporary MAC change support
 * Tunable SOFs parameter - ioctl()?
 * Ethernet stats collection
 * Code formatting improvements
 */

#include <linux/module.h>
#include <linux/sched.h>
#include <linux/slab.h>
#include <linux/string.h>
#include <linux/init.h>
#include <linux/delay.h>
#include <linux/netdevice.h>
#include <linux/etherdevice.h>
#include <linux/usb.h>
#include <linux/types.h>
#include <asm/semaphore.h>
59
#include <asm/byteorder.h>
Linus Torvalds's avatar
Linus Torvalds committed
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105

#define DEBUG

#ifdef DEBUG
#define kaweth_dbg(format, arg...) printk(KERN_DEBUG __FILE__ ": " format "\n" ,##arg)
#else
#define kaweth_dbg(format, arg...) do {} while (0)
#endif
#define kaweth_err(format, arg...) printk(KERN_ERR __FILE__ ": " format "\n" ,##arg)
#define kaweth_info(format, arg...) printk(KERN_INFO __FILE__ ": " format "\n" , ##arg)
#define kaweth_warn(format, arg...) printk(KERN_WARNING __FILE__ ": " format "\n" , ##arg)


#include "kawethfw.h"

#define KAWETH_MTU			1514
#define KAWETH_BUF_SIZE			1664
#define KAWETH_TX_TIMEOUT		(5 * HZ)
#define KAWETH_FIRMWARE_BUF_SIZE	4096
#define KAWETH_CONTROL_TIMEOUT		(30 * HZ)

#define KAWETH_STATUS_BROKEN		0x0000001
#define KAWETH_STATUS_CLOSING		0x0000002

#define KAWETH_PACKET_FILTER_PROMISCUOUS	0x01
#define KAWETH_PACKET_FILTER_ALL_MULTICAST	0x02
#define KAWETH_PACKET_FILTER_DIRECTED		0x04
#define KAWETH_PACKET_FILTER_BROADCAST		0x08
#define KAWETH_PACKET_FILTER_MULTICAST		0x10

/* Table 7 */
#define KAWETH_COMMAND_GET_ETHERNET_DESC	0x00
#define KAWETH_COMMAND_MULTICAST_FILTERS        0x01
#define KAWETH_COMMAND_SET_PACKET_FILTER	0x02
#define KAWETH_COMMAND_STATISTICS               0x03
#define KAWETH_COMMAND_SET_TEMP_MAC     	0x06
#define KAWETH_COMMAND_GET_TEMP_MAC             0x07
#define KAWETH_COMMAND_SET_URB_SIZE		0x08
#define KAWETH_COMMAND_SET_SOFS_WAIT		0x09
#define KAWETH_COMMAND_SCAN			0xFF

#define KAWETH_SOFS_TO_WAIT			0x05


MODULE_AUTHOR("Michael Zappe <zapman@interlan.net>, Stephane Alnet <stephane@u-picardie.fr> and Brad Hards <bhards@bigpond.net.au>");
MODULE_DESCRIPTION("KL5USB101 USB Ethernet driver");
Linus Torvalds's avatar
Linus Torvalds committed
106
MODULE_LICENSE("GPL");
Linus Torvalds's avatar
Linus Torvalds committed
107 108 109 110 111 112 113 114

static void *kaweth_probe(
            struct usb_device *dev,             /* the device */
            unsigned ifnum,                     /* what interface */
            const struct usb_device_id *id      /* from id_table */
	);
static void kaweth_disconnect(struct usb_device *dev, void *ptr);
int kaweth_internal_control_msg(struct usb_device *usb_dev, unsigned int pipe,
Linus Torvalds's avatar
Linus Torvalds committed
115 116
				struct usb_ctrlrequest *cmd, void *data,
				int len, int timeout);
Linus Torvalds's avatar
Linus Torvalds committed
117 118 119 120 121

/****************************************************************
 *     usb_device_id
 ****************************************************************/
static struct usb_device_id usb_klsi_table[] = {
122
	{ USB_DEVICE(0x03e8, 0x0008) }, /* AOX Endpoints USB Ethernet */
Linus Torvalds's avatar
Linus Torvalds committed
123
	{ USB_DEVICE(0x04bb, 0x0901) }, /* I-O DATA USB-ET/T */
124 125 126
	{ USB_DEVICE(0x0506, 0x03e8) }, /* 3Com 3C19250 */
	{ USB_DEVICE(0x0557, 0x2002) }, /* ATEN USB Ethernet */
	{ USB_DEVICE(0x0557, 0x4000) }, /* D-Link DSB-650C */
Linus Torvalds's avatar
Linus Torvalds committed
127
	{ USB_DEVICE(0x0565, 0x0002) }, /* Peracom Enet */
Oliver Neukum's avatar
Oliver Neukum committed
128
	{ USB_DEVICE(0x0565, 0x0003) }, /* Optus@Home UEP1045A */
129
	{ USB_DEVICE(0x0565, 0x0005) }, /* Peracom Enet2 */
Linus Torvalds's avatar
Linus Torvalds committed
130 131
	{ USB_DEVICE(0x05e9, 0x0008) }, /* KLSI KL5KUSB101B */
	{ USB_DEVICE(0x05e9, 0x0009) }, /* KLSI KL5KUSB101B (Board change) */
132 133 134 135 136
	{ USB_DEVICE(0x066b, 0x2202) }, /* Linksys USB10T */
	{ USB_DEVICE(0x06e1, 0x0008) }, /* ADS USB-10BT */
	{ USB_DEVICE(0x06e1, 0x0009) }, /* ADS USB-10BT */
	{ USB_DEVICE(0x0707, 0x0100) }, /* SMC 2202USB */
	{ USB_DEVICE(0x07aa, 0x0001) }, /* Correga K.K. */
Linus Torvalds's avatar
Linus Torvalds committed
137 138 139 140 141 142 143 144 145 146 147
	{ USB_DEVICE(0x07b8, 0x4000) }, /* D-Link DU-E10 */
	{ USB_DEVICE(0x0846, 0x1001) }, /* NetGear EA-101 */
	{ USB_DEVICE(0x0846, 0x1002) }, /* NetGear EA-101 */
	{ USB_DEVICE(0x085a, 0x0008) }, /* PortGear Ethernet Adapter */
	{ USB_DEVICE(0x085a, 0x0009) }, /* PortGear Ethernet Adapter */
	{ USB_DEVICE(0x087d, 0x5704) }, /* Jaton USB Ethernet Device Adapter */
	{ USB_DEVICE(0x0951, 0x0008) }, /* Kingston Technology USB Ethernet Adapter */
	{ USB_DEVICE(0x095a, 0x3003) }, /* Portsmith Express Ethernet Adapter */
	{ USB_DEVICE(0x10bd, 0x1427) }, /* ASANTE USB To Ethernet Adapter */
	{ USB_DEVICE(0x1342, 0x0204) }, /* Mobility USB-Ethernet Adapter */
	{ USB_DEVICE(0x13d2, 0x0400) }, /* Shark Pocket Adapter */
148 149 150
	{ USB_DEVICE(0x1645, 0x0005) }, /* Entrega E45 */
	{ USB_DEVICE(0x1645, 0x0008) }, /* Entrega USB Ethernet Adapter */
	{ USB_DEVICE(0x1645, 0x8005) }, /* PortGear Ethernet Adapter */
Linus Torvalds's avatar
Linus Torvalds committed
151 152 153 154 155 156 157 158 159 160
	{ USB_DEVICE(0x2001, 0x4000) }, /* D-link DSB-650C */
	{} /* Null terminator */
};

MODULE_DEVICE_TABLE (usb, usb_klsi_table);

/****************************************************************
 *     kaweth_driver
 ****************************************************************/
static struct usb_driver kaweth_driver = {
161
	owner:		THIS_MODULE,
Linus Torvalds's avatar
Linus Torvalds committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203
	name:		"kaweth",
	probe:		kaweth_probe,
	disconnect:	kaweth_disconnect,
	id_table:       usb_klsi_table,
};

typedef __u8 eth_addr_t[6];

/****************************************************************
 *     usb_eth_dev
 ****************************************************************/
struct usb_eth_dev {
	char *name;
	__u16 vendor;
	__u16 device;
	void *pdata;
};

/****************************************************************
 *     kaweth_ethernet_configuration
 *     Refer Table 8
 ****************************************************************/
struct kaweth_ethernet_configuration
{
	__u8 size;
	__u8 reserved1;
	__u8 reserved2;
	eth_addr_t hw_addr;
	__u32 statistics_mask;
	__u16 segment_size;
	__u16 max_multicast_filters;
	__u8 reserved3;
} __attribute__ ((packed));

/****************************************************************
 *     kaweth_device
 ****************************************************************/
struct kaweth_device
{
	spinlock_t device_lock;

	__u32 status;
204 205
	int end;
	int removed;
Linus Torvalds's avatar
Linus Torvalds committed
206 207 208

	struct usb_device *dev;
	struct net_device *net;
209
	wait_queue_head_t term_wait;
Linus Torvalds's avatar
Linus Torvalds committed
210 211 212

	struct urb *rx_urb;
	struct urb *tx_urb;
213

Linus Torvalds's avatar
Linus Torvalds committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228
	__u8 firmware_buf[KAWETH_FIRMWARE_BUF_SIZE];
	__u8 tx_buf[KAWETH_BUF_SIZE];
	__u8 rx_buf[KAWETH_BUF_SIZE];
	__u16 packet_filter_bitmap;

	struct kaweth_ethernet_configuration configuration;

	struct net_device_stats stats;
} __attribute__ ((packed));


/****************************************************************
 *     kaweth_control
 ****************************************************************/
static int kaweth_control(struct kaweth_device *kaweth,
229 230 231 232
			  unsigned int pipe,
			  __u8 request,
			  __u8 requesttype,
			  __u16 value,
Linus Torvalds's avatar
Linus Torvalds committed
233
			  __u16 index,
234 235
			  void *data,
			  __u16 size,
Linus Torvalds's avatar
Linus Torvalds committed
236 237
			  int timeout)
{
Linus Torvalds's avatar
Linus Torvalds committed
238
	struct usb_ctrlrequest *dr;
Linus Torvalds's avatar
Linus Torvalds committed
239 240 241 242 243 244 245 246

	kaweth_dbg("kaweth_control()");

	if(in_interrupt()) {
		kaweth_dbg("in_interrupt()");
		return -EBUSY;
	}

247
	dr = kmalloc(sizeof(struct usb_ctrlrequest), GFP_ATOMIC);
Linus Torvalds's avatar
Linus Torvalds committed
248

Linus Torvalds's avatar
Linus Torvalds committed
249
	if (!dr) {
Linus Torvalds's avatar
Linus Torvalds committed
250 251 252
		kaweth_dbg("kmalloc() failed");
		return -ENOMEM;
	}
253

Linus Torvalds's avatar
Linus Torvalds committed
254 255 256 257 258
	dr->bRequestType= requesttype;
	dr->bRequest = request;
	dr->wValue = cpu_to_le16p(&value);
	dr->wIndex = cpu_to_le16p(&index);
	dr->wLength = cpu_to_le16p(&size);
Linus Torvalds's avatar
Linus Torvalds committed
259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

	return kaweth_internal_control_msg(kaweth->dev,
					pipe,
					dr,
					data,
					size,
					timeout);
}

/****************************************************************
 *     kaweth_read_configuration
 ****************************************************************/
static int kaweth_read_configuration(struct kaweth_device *kaweth)
{
	int retval;

	kaweth_dbg("Reading kaweth configuration");

	retval = kaweth_control(kaweth,
				usb_rcvctrlpipe(kaweth->dev, 0),
				KAWETH_COMMAND_GET_ETHERNET_DESC,
				USB_TYPE_VENDOR | USB_DIR_IN | USB_RECIP_DEVICE,
				0,
				0,
				(void *)&kaweth->configuration,
				sizeof(kaweth->configuration),
				KAWETH_CONTROL_TIMEOUT);

	return retval;
}

/****************************************************************
 *     kaweth_set_urb_size
 ****************************************************************/
static int kaweth_set_urb_size(struct kaweth_device *kaweth, __u16 urb_size)
{
	int retval;

	kaweth_dbg("Setting URB size to %d", (unsigned)urb_size);

	retval = kaweth_control(kaweth,
				usb_sndctrlpipe(kaweth->dev, 0),
				KAWETH_COMMAND_SET_URB_SIZE,
				USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
				urb_size,
				0,
				(void *)&kaweth->firmware_buf,
				0,
				KAWETH_CONTROL_TIMEOUT);

	return retval;
}

/****************************************************************
 *     kaweth_set_sofs_wait
 ****************************************************************/
static int kaweth_set_sofs_wait(struct kaweth_device *kaweth, __u16 sofs_wait)
{
	int retval;

	kaweth_dbg("Set SOFS wait to %d", (unsigned)sofs_wait);

	retval = kaweth_control(kaweth,
				usb_sndctrlpipe(kaweth->dev, 0),
				KAWETH_COMMAND_SET_SOFS_WAIT,
				USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
				sofs_wait,
				0,
				(void *)&kaweth->firmware_buf,
				0,
				KAWETH_CONTROL_TIMEOUT);

	return retval;
}

/****************************************************************
 *     kaweth_set_receive_filter
 ****************************************************************/
static int kaweth_set_receive_filter(struct kaweth_device *kaweth,
				     __u16 receive_filter)
{
	int retval;

	kaweth_dbg("Set receive filter to %d", (unsigned)receive_filter);

	retval = kaweth_control(kaweth,
				usb_sndctrlpipe(kaweth->dev, 0),
				KAWETH_COMMAND_SET_PACKET_FILTER,
				USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
				receive_filter,
				0,
				(void *)&kaweth->firmware_buf,
				0,
				KAWETH_CONTROL_TIMEOUT);

	return retval;
}

/****************************************************************
 *     kaweth_download_firmware
 ****************************************************************/
360 361
static int kaweth_download_firmware(struct kaweth_device *kaweth,
				    __u8 *data,
Linus Torvalds's avatar
Linus Torvalds committed
362 363 364
				    __u16 data_len,
				    __u8 interrupt,
				    __u8 type)
365
{
Linus Torvalds's avatar
Linus Torvalds committed
366 367 368 369
	if(data_len > KAWETH_FIRMWARE_BUF_SIZE)	{
		kaweth_err("Firmware too big: %d", data_len);
		return -ENOSPC;
	}
370

Linus Torvalds's avatar
Linus Torvalds committed
371
	memcpy(kaweth->firmware_buf, data, data_len);
372

Linus Torvalds's avatar
Linus Torvalds committed
373 374 375 376 377
	kaweth->firmware_buf[2] = (data_len & 0xFF) - 7;
	kaweth->firmware_buf[3] = data_len >> 8;
	kaweth->firmware_buf[4] = type;
	kaweth->firmware_buf[5] = interrupt;

Linus Torvalds's avatar
Linus Torvalds committed
378 379 380
	kaweth_dbg("High: %i, Low:%i", kaweth->firmware_buf[3],
		   kaweth->firmware_buf[2]);

381 382
	kaweth_dbg("Downloading firmware at %p to kaweth device at %p",
	    data,
Linus Torvalds's avatar
Linus Torvalds committed
383
	    kaweth);
Linus Torvalds's avatar
Linus Torvalds committed
384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
	kaweth_dbg("Firmware length: %d", data_len);

	return kaweth_control(kaweth,
		              usb_sndctrlpipe(kaweth->dev, 0),
			      KAWETH_COMMAND_SCAN,
			      USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
			      0,
			      0,
			      (void *)&kaweth->firmware_buf,
			      data_len,
			      KAWETH_CONTROL_TIMEOUT);
}

/****************************************************************
 *     kaweth_trigger_firmware
 ****************************************************************/
static int kaweth_trigger_firmware(struct kaweth_device *kaweth,
				   __u8 interrupt)
{
	kaweth->firmware_buf[0] = 0xB6;
	kaweth->firmware_buf[1] = 0xC3;
	kaweth->firmware_buf[2] = 0x01;
	kaweth->firmware_buf[3] = 0x00;
	kaweth->firmware_buf[4] = 0x06;
	kaweth->firmware_buf[5] = interrupt;
	kaweth->firmware_buf[6] = 0x00;
	kaweth->firmware_buf[7] = 0x00;
411

Linus Torvalds's avatar
Linus Torvalds committed
412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
	kaweth_dbg("Triggering firmware");

	return kaweth_control(kaweth,
			      usb_sndctrlpipe(kaweth->dev, 0),
			      KAWETH_COMMAND_SCAN,
			      USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
			      0,
			      0,
			      (void *)&kaweth->firmware_buf,
			      8,
			      KAWETH_CONTROL_TIMEOUT);
}

/****************************************************************
 *     kaweth_reset
 ****************************************************************/
static int kaweth_reset(struct kaweth_device *kaweth)
{
	int result;

	kaweth_dbg("kaweth_reset(%p)", kaweth);
	result = kaweth_control(kaweth,
				usb_sndctrlpipe(kaweth->dev, 0),
435 436
				USB_REQ_SET_CONFIGURATION,
				0,
Linus Torvalds's avatar
Linus Torvalds committed
437
				kaweth->dev->config[0].bConfigurationValue,
438 439 440
				0,
				NULL,
				0,
Linus Torvalds's avatar
Linus Torvalds committed
441 442 443 444 445 446 447 448 449 450 451 452 453 454
				KAWETH_CONTROL_TIMEOUT);

	udelay(10000);

	kaweth_dbg("kaweth_reset() returns %d.",result);

	return result;
}

static void kaweth_usb_receive(struct urb *);

/****************************************************************
 *     kaweth_resubmit_rx_urb
 ****************************************************************/
455 456
static inline void kaweth_resubmit_rx_urb(struct kaweth_device *kaweth,
						int mem_flags)
Linus Torvalds's avatar
Linus Torvalds committed
457 458 459 460 461 462 463 464 465 466 467 468 469
{
	int result;

	memset(kaweth->rx_urb, 0, sizeof(*kaweth->rx_urb));

	FILL_BULK_URB(kaweth->rx_urb,
		      kaweth->dev,
		      usb_rcvbulkpipe(kaweth->dev, 1),
		      kaweth->rx_buf,
		      KAWETH_BUF_SIZE,
		      kaweth_usb_receive,
		      kaweth);

470
	if((result = usb_submit_urb(kaweth->rx_urb, mem_flags))) {
Linus Torvalds's avatar
Linus Torvalds committed
471 472 473 474 475 476 477 478 479 480 481 482 483
		kaweth_err("resubmitting rx_urb %d failed", result);
	}
}

static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth);

/****************************************************************
 *     kaweth_usb_receive
 ****************************************************************/
static void kaweth_usb_receive(struct urb *urb)
{
	struct kaweth_device *kaweth = urb->context;
	struct net_device *net = kaweth->net;
484

Linus Torvalds's avatar
Linus Torvalds committed
485 486
	int count = urb->actual_length;
	int count2 = urb->transfer_buffer_length;
487

Linus Torvalds's avatar
Linus Torvalds committed
488
	__u16 pkt_len = le16_to_cpup((u16 *)kaweth->rx_buf);
Linus Torvalds's avatar
Linus Torvalds committed
489 490 491 492 493 494

	struct sk_buff *skb;

	if(kaweth->status & KAWETH_STATUS_CLOSING) {
		return;
	}
495 496 497 498 499 500 501 502 503 504

	if(unlikely(urb->status == -ECONNRESET || urb->status == -ECONNABORTED))
	/* we are killed - set a flag and wake the disconnect handler */
	{
		kaweth->end = 1;
		wake_up(&kaweth->term_wait);
		return;
	}

	if(urb->status && urb->status != -EREMOTEIO && count != 1) {
Linus Torvalds's avatar
Linus Torvalds committed
505
		kaweth_err("%s RX status: %d count: %d packet_len: %d",
506
                           net->name,
Linus Torvalds's avatar
Linus Torvalds committed
507
			   urb->status,
508
			   count,
Linus Torvalds's avatar
Linus Torvalds committed
509
			   (int)pkt_len);
510
		kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
Linus Torvalds's avatar
Linus Torvalds committed
511 512 513 514 515 516 517 518
                return;
	}

	if(kaweth->net && (count > 2)) {
		if(pkt_len > (count - 2)) {
			kaweth_err("Packet length too long for USB frame (pkt_len: %x, count: %x)",pkt_len, count);
			kaweth_err("Packet len & 2047: %x", pkt_len & 2047);
			kaweth_err("Count 2: %x", count2);
519
		        kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
Linus Torvalds's avatar
Linus Torvalds committed
520 521
                        return;
                }
522

Linus Torvalds's avatar
Linus Torvalds committed
523
		if(!(skb = dev_alloc_skb(pkt_len+2))) {
524
		        kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
Linus Torvalds's avatar
Linus Torvalds committed
525 526 527 528 529 530
                        return;
		}

		skb->dev = net;

		eth_copy_and_sum(skb, kaweth->rx_buf + 2, pkt_len, 0);
531

Linus Torvalds's avatar
Linus Torvalds committed
532 533 534
		skb_put(skb, pkt_len);

		skb->protocol = eth_type_trans(skb, net);
535

Linus Torvalds's avatar
Linus Torvalds committed
536
		netif_rx(skb);
537

Linus Torvalds's avatar
Linus Torvalds committed
538 539 540 541
		kaweth->stats.rx_packets++;
		kaweth->stats.rx_bytes += pkt_len;
	}

542
	kaweth_resubmit_rx_urb(kaweth, GFP_ATOMIC);
Linus Torvalds's avatar
Linus Torvalds committed
543 544 545 546 547 548 549 550 551 552 553 554 555
}

/****************************************************************
 *     kaweth_open
 ****************************************************************/
static int kaweth_open(struct net_device *net)
{
	struct kaweth_device *kaweth = (struct kaweth_device *)net->priv;

	kaweth_dbg("Dev usage: %d", kaweth->dev->refcnt.counter);

	kaweth_dbg("Opening network device.");

556
	MOD_INC_USE_COUNT;
Linus Torvalds's avatar
Linus Torvalds committed
557

558
	kaweth_resubmit_rx_urb(kaweth, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
559

560
	netif_start_queue(net);
Linus Torvalds's avatar
Linus Torvalds committed
561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602

	kaweth_async_set_rx_mode(kaweth);
	return 0;
}

/****************************************************************
 *     kaweth_close
 ****************************************************************/
static int kaweth_close(struct net_device *net)
{
	struct kaweth_device *kaweth = net->priv;

	netif_stop_queue(net);

	kaweth->status |= KAWETH_STATUS_CLOSING;

	usb_unlink_urb(kaweth->rx_urb);

	kaweth->status &= ~KAWETH_STATUS_CLOSING;

	MOD_DEC_USE_COUNT;

	printk("Dev usage: %d", kaweth->dev->refcnt.counter);

	return 0;
}

/****************************************************************
 *     kaweth_ioctl
 ****************************************************************/
static int kaweth_ioctl(struct net_device *net, struct ifreq *rq, int cmd)
{
	return -EOPNOTSUPP;
}

/****************************************************************
 *     kaweth_usb_transmit_complete
 ****************************************************************/
static void kaweth_usb_transmit_complete(struct urb *urb)
{
	struct kaweth_device *kaweth = urb->context;

603
	if (unlikely(urb->status != 0))
Linus Torvalds's avatar
Linus Torvalds committed
604 605 606 607 608 609 610 611 612 613 614 615
		kaweth_dbg("%s: TX status %d.", kaweth->net->name, urb->status);

	netif_wake_queue(kaweth->net);
}

/****************************************************************
 *     kaweth_start_xmit
 ****************************************************************/
static int kaweth_start_xmit(struct sk_buff *skb, struct net_device *net)
{
	struct kaweth_device *kaweth = net->priv;
	int count = skb->len;
616

Linus Torvalds's avatar
Linus Torvalds committed
617 618 619 620
	int res;

	spin_lock(&kaweth->device_lock);

621 622 623 624 625 626 627
	if (kaweth->removed) {
	/* our device is undergoing disconnection - we bail out */
		spin_unlock(&kaweth->device_lock);
		dev_kfree_skb(skb);
		return 0;
	}

Linus Torvalds's avatar
Linus Torvalds committed
628 629 630
	kaweth_async_set_rx_mode(kaweth);
	netif_stop_queue(net);

Linus Torvalds's avatar
Linus Torvalds committed
631
	*((__u16 *)kaweth->tx_buf) = cpu_to_le16(skb->len);
Linus Torvalds's avatar
Linus Torvalds committed
632 633 634 635 636 637 638 639 640 641 642 643

	memcpy(kaweth->tx_buf + 2, skb->data, skb->len);

	memset(kaweth->tx_urb, 0, sizeof(*kaweth->tx_urb));

	FILL_BULK_URB(kaweth->tx_urb,
		      kaweth->dev,
		      usb_sndbulkpipe(kaweth->dev, 2),
		      kaweth->tx_buf,
		      count + 2,
		      kaweth_usb_transmit_complete,
		      kaweth);
644 645
	kaweth->end = 0;
	kaweth->tx_urb->transfer_flags |= USB_ASYNC_UNLINK;
Linus Torvalds's avatar
Linus Torvalds committed
646

647
	if((res = usb_submit_urb(kaweth->tx_urb, GFP_ATOMIC)))
Linus Torvalds's avatar
Linus Torvalds committed
648 649 650
	{
		kaweth_warn("kaweth failed tx_urb %d", res);
		kaweth->stats.tx_errors++;
651

Linus Torvalds's avatar
Linus Torvalds committed
652
		netif_start_queue(net);
653 654
	}
	else
Linus Torvalds's avatar
Linus Torvalds committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673
	{
		kaweth->stats.tx_packets++;
		kaweth->stats.tx_bytes += skb->len;
		net->trans_start = jiffies;
	}

	dev_kfree_skb(skb);

	spin_unlock(&kaweth->device_lock);

	return 0;
}

/****************************************************************
 *     kaweth_set_rx_mode
 ****************************************************************/
static void kaweth_set_rx_mode(struct net_device *net)
{
	struct kaweth_device *kaweth = net->priv;
674

Linus Torvalds's avatar
Linus Torvalds committed
675 676 677 678 679 680 681 682 683 684
	__u16 packet_filter_bitmap = KAWETH_PACKET_FILTER_DIRECTED |
                                     KAWETH_PACKET_FILTER_BROADCAST |
		                     KAWETH_PACKET_FILTER_MULTICAST;

	kaweth_dbg("Setting Rx mode to %d", packet_filter_bitmap);

	netif_stop_queue(net);

	if (net->flags & IFF_PROMISC) {
		packet_filter_bitmap |= KAWETH_PACKET_FILTER_PROMISCUOUS;
685
	}
Linus Torvalds's avatar
Linus Torvalds committed
686 687 688 689 690 691 692 693 694 695 696 697 698 699
	else if ((net->mc_count) || (net->flags & IFF_ALLMULTI)) {
		packet_filter_bitmap |= KAWETH_PACKET_FILTER_ALL_MULTICAST;
	}

	kaweth->packet_filter_bitmap = packet_filter_bitmap;
	netif_wake_queue(net);
}

/****************************************************************
 *     kaweth_async_set_rx_mode
 ****************************************************************/
static void kaweth_async_set_rx_mode(struct kaweth_device *kaweth)
{
	__u16 packet_filter_bitmap = kaweth->packet_filter_bitmap;
700
	kaweth->packet_filter_bitmap = 0;
Linus Torvalds's avatar
Linus Torvalds committed
701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759
	if(packet_filter_bitmap == 0) return;

	{
	int result;
	result = kaweth_control(kaweth,
				usb_sndctrlpipe(kaweth->dev, 0),
				KAWETH_COMMAND_SET_PACKET_FILTER,
				USB_TYPE_VENDOR | USB_DIR_OUT | USB_RECIP_DEVICE,
				packet_filter_bitmap,
				0,
				(void *)&kaweth->firmware_buf,
				0,
				KAWETH_CONTROL_TIMEOUT);

	if(result < 0) {
		kaweth_err("Failed to set Rx mode: %d", result);
	}
	else {
		kaweth_dbg("Set Rx mode to %d", packet_filter_bitmap);
	}
	}
}

/****************************************************************
 *     kaweth_netdev_stats
 ****************************************************************/
static struct net_device_stats *kaweth_netdev_stats(struct net_device *dev)
{
	return &((struct kaweth_device *)dev->priv)->stats;
}

/****************************************************************
 *     kaweth_tx_timeout
 ****************************************************************/
static void kaweth_tx_timeout(struct net_device *net)
{
	struct kaweth_device *kaweth = net->priv;

	kaweth_warn("%s: Tx timed out. Resetting.", net->name);
	kaweth->stats.tx_errors++;
	net->trans_start = jiffies;

	usb_unlink_urb(kaweth->tx_urb);
}

/****************************************************************
 *     kaweth_probe
 ****************************************************************/
static void *kaweth_probe(
            struct usb_device *dev,             /* the device */
            unsigned ifnum,                      /* what interface */
            const struct usb_device_id *id      /* from id_table */
	)
{
	struct kaweth_device *kaweth;
	const eth_addr_t bcast_addr = { 0xFF, 0xFF, 0xFF, 0xFF, 0xFF, 0xFF };
	int result = 0;

	kaweth_dbg("Kawasaki Device Probe (Device number:%d): 0x%4.4x:0x%4.4x:0x%4.4x",
760 761
		 dev->devnum,
		 (int)dev->descriptor.idVendor,
Linus Torvalds's avatar
Linus Torvalds committed
762 763 764 765 766
		 (int)dev->descriptor.idProduct,
		 (int)dev->descriptor.bcdDevice);

	kaweth_dbg("Device at %p", dev);

767
	kaweth_dbg("Descriptor length: %x type: %x",
Linus Torvalds's avatar
Linus Torvalds committed
768 769 770 771 772 773 774 775 776 777 778
		 (int)dev->descriptor.bLength,
		 (int)dev->descriptor.bDescriptorType);

	if(!(kaweth = kmalloc(sizeof(struct kaweth_device), GFP_KERNEL))) {
		kaweth_dbg("out of memory allocating device structure\n");
		return NULL;
	}

	memset(kaweth, 0, sizeof(struct kaweth_device));

	kaweth->dev = dev;
779
	spin_lock_init(&kaweth->device_lock);
780 781
	init_waitqueue_head(&kaweth->term_wait);

Linus Torvalds's avatar
Linus Torvalds committed
782 783 784 785 786 787 788 789 790 791 792 793 794 795
	kaweth_dbg("Resetting.");

	kaweth_reset(kaweth);

	/*
	 * If high byte of bcdDevice is nonzero, firmware is already
	 * downloaded. Don't try to do it again, or we'll hang the device.
	 */

	if (dev->descriptor.bcdDevice >> 8) {
		kaweth_info("Firmware present in device.");
	} else {
		/* Download the firmware */
		kaweth_info("Downloading firmware...");
796 797 798 799
		if ((result = kaweth_download_firmware(kaweth,
						      kaweth_new_code,
						      len_kaweth_new_code,
						      100,
Linus Torvalds's avatar
Linus Torvalds committed
800 801 802 803 804 805
						      2)) < 0) {
			kaweth_err("Error downloading firmware (%d)", result);
			kfree(kaweth);
			return NULL;
		}

806 807 808 809
		if ((result = kaweth_download_firmware(kaweth,
						      kaweth_new_code_fix,
						      len_kaweth_new_code_fix,
						      100,
Linus Torvalds's avatar
Linus Torvalds committed
810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844
						      3)) < 0) {
			kaweth_err("Error downloading firmware fix (%d)", result);
			kfree(kaweth);
			return NULL;
		}

		if ((result = kaweth_download_firmware(kaweth,
						      kaweth_trigger_code,
						      len_kaweth_trigger_code,
						      126,
						      2)) < 0) {
			kaweth_err("Error downloading trigger code (%d)", result);
			kfree(kaweth);
			return NULL;
		}

		if ((result = kaweth_download_firmware(kaweth,
						      kaweth_trigger_code_fix,
						      len_kaweth_trigger_code_fix,
						      126,
						      3)) < 0) {
			kaweth_err("Error downloading trigger code fix (%d)", result);
			kfree(kaweth);
			return NULL;
		}


		if ((result = kaweth_trigger_firmware(kaweth, 126)) < 0) {
			kaweth_err("Error triggering firmware (%d)", result);
			kfree(kaweth);
			return NULL;
		}

		/* Device will now disappear for a moment...  */
		kaweth_info("Firmware loaded.  I'll be back...");
845
		kfree(kaweth);
Linus Torvalds's avatar
Linus Torvalds committed
846 847 848 849 850 851 852 853 854 855 856 857 858
		return NULL;
	}

	result = kaweth_read_configuration(kaweth);

	if(result < 0) {
		kaweth_err("Error reading configuration (%d), no net device created", result);
		kfree(kaweth);
		return NULL;
	}

	kaweth_info("Statistics collection: %x", kaweth->configuration.statistics_mask);
	kaweth_info("Multicast filter limit: %x", kaweth->configuration.max_multicast_filters & ((1 << 15) - 1));
Linus Torvalds's avatar
Linus Torvalds committed
859
	kaweth_info("MTU: %d", le16_to_cpu(kaweth->configuration.segment_size));
Linus Torvalds's avatar
Linus Torvalds committed
860 861 862 863 864 865 866 867 868
	kaweth_info("Read MAC address %2.2x:%2.2x:%2.2x:%2.2x:%2.2x:%2.2x",
		 (int)kaweth->configuration.hw_addr[0],
		 (int)kaweth->configuration.hw_addr[1],
		 (int)kaweth->configuration.hw_addr[2],
		 (int)kaweth->configuration.hw_addr[3],
		 (int)kaweth->configuration.hw_addr[4],
		 (int)kaweth->configuration.hw_addr[5]);

	if(!memcmp(&kaweth->configuration.hw_addr,
869
                   &bcast_addr,
Linus Torvalds's avatar
Linus Torvalds committed
870 871 872 873 874 875 876 877 878 879
		   sizeof(bcast_addr))) {
		kaweth_err("Firmware not functioning properly, no net device created");
		kfree(kaweth);
		return NULL;
	}

	if(kaweth_set_urb_size(kaweth, KAWETH_BUF_SIZE) < 0) {
		kaweth_dbg("Error setting URB size");
		return kaweth;
	}
880

Linus Torvalds's avatar
Linus Torvalds committed
881 882 883 884 885
	if(kaweth_set_sofs_wait(kaweth, KAWETH_SOFS_TO_WAIT) < 0) {
		kaweth_err("Error setting SOFS wait");
		return kaweth;
	}

886
	result = kaweth_set_receive_filter(kaweth,
Linus Torvalds's avatar
Linus Torvalds committed
887 888 889 890 891 892 893 894
                                           KAWETH_PACKET_FILTER_DIRECTED |
                                           KAWETH_PACKET_FILTER_BROADCAST |
                                           KAWETH_PACKET_FILTER_MULTICAST);

	if(result < 0) {
		kaweth_err("Error setting receive filter");
		return kaweth;
	}
895

Linus Torvalds's avatar
Linus Torvalds committed
896 897
	kaweth_dbg("Initializing net device.");

898 899
	kaweth->tx_urb = usb_alloc_urb(0, GFP_KERNEL);
	kaweth->rx_urb = usb_alloc_urb(0, GFP_KERNEL);
Linus Torvalds's avatar
Linus Torvalds committed
900 901

	kaweth->net = init_etherdev(0, 0);
Linus Torvalds's avatar
Linus Torvalds committed
902 903 904 905
	if (!kaweth->net) {
		kaweth_err("Error calling init_etherdev.");
		return kaweth;
	}
Linus Torvalds's avatar
Linus Torvalds committed
906 907

	memcpy(kaweth->net->broadcast, &bcast_addr, sizeof(bcast_addr));
908
	memcpy(kaweth->net->dev_addr,
Linus Torvalds's avatar
Linus Torvalds committed
909 910
               &kaweth->configuration.hw_addr,
               sizeof(kaweth->configuration.hw_addr));
911

Linus Torvalds's avatar
Linus Torvalds committed
912 913 914 915 916 917
	kaweth->net->priv = kaweth;
	kaweth->net->open = kaweth_open;
	kaweth->net->stop = kaweth_close;

	kaweth->net->watchdog_timeo = KAWETH_TX_TIMEOUT;
	kaweth->net->tx_timeout = kaweth_tx_timeout;
918

Linus Torvalds's avatar
Linus Torvalds committed
919 920 921 922
	kaweth->net->do_ioctl = kaweth_ioctl;
	kaweth->net->hard_start_xmit = kaweth_start_xmit;
	kaweth->net->set_multicast_list = kaweth_set_rx_mode;
	kaweth->net->get_stats = kaweth_netdev_stats;
Linus Torvalds's avatar
Linus Torvalds committed
923
	kaweth->net->mtu = le16_to_cpu(kaweth->configuration.segment_size);
Linus Torvalds's avatar
Linus Torvalds committed
924 925 926 927

	memset(&kaweth->stats, 0, sizeof(kaweth->stats));

	kaweth_info("kaweth interface created at %s", kaweth->net->name);
928

Linus Torvalds's avatar
Linus Torvalds committed
929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946
	kaweth_dbg("Kaweth probe returning.");

	return kaweth;
}

/****************************************************************
 *     kaweth_disconnect
 ****************************************************************/
static void kaweth_disconnect(struct usb_device *dev, void *ptr)
{
	struct kaweth_device *kaweth = ptr;

	kaweth_info("Unregistering");

	if (!kaweth) {
		kaweth_warn("unregistering non-existant device");
		return;
	}
947 948

	kaweth->removed = 1;
949
	usb_unlink_urb(kaweth->rx_urb);
Linus Torvalds's avatar
Linus Torvalds committed
950

951 952 953 954 955 956 957 958 959
	/* we need to wait for the urb to be cancelled, if it is active */
	spin_lock(&kaweth->device_lock);
	if (usb_unlink_urb(kaweth->tx_urb) == -EINPROGRESS) {
		spin_unlock(&kaweth->device_lock);
		wait_event(kaweth->term_wait, kaweth->end);
	} else {
		spin_unlock(&kaweth->device_lock);
	}

Linus Torvalds's avatar
Linus Torvalds committed
960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976
	if(kaweth->net) {
		if(kaweth->net->flags & IFF_UP) {
			kaweth_dbg("Closing net device");
			dev_close(kaweth->net);
		}

		kaweth_dbg("Unregistering net device");
		unregister_netdev(kaweth->net);
	}

	usb_free_urb(kaweth->rx_urb);
	usb_free_urb(kaweth->tx_urb);

	kfree(kaweth);
}


Linus Torvalds's avatar
Linus Torvalds committed
977
// FIXME this completion stuff is a modified clone of
978
// an OLD version of some stuff in usb.c ...
Linus Torvalds's avatar
Linus Torvalds committed
979 980 981 982 983
struct usb_api_data {
	wait_queue_head_t wqh;
	int done;
};

Linus Torvalds's avatar
Linus Torvalds committed
984 985 986
/*-------------------------------------------------------------------*
 * completion handler for compatibility wrappers (sync control/bulk) *
 *-------------------------------------------------------------------*/
Linus Torvalds's avatar
Linus Torvalds committed
987
static void usb_api_blocking_completion(struct urb *urb)
Linus Torvalds's avatar
Linus Torvalds committed
988
{
Linus Torvalds's avatar
Linus Torvalds committed
989
        struct usb_api_data *awd = (struct usb_api_data *)urb->context;
Linus Torvalds's avatar
Linus Torvalds committed
990

Linus Torvalds's avatar
Linus Torvalds committed
991 992
	awd->done=1;
	wake_up(&awd->wqh);
Linus Torvalds's avatar
Linus Torvalds committed
993 994 995 996 997 998 999
}

/*-------------------------------------------------------------------*
 *                         COMPATIBILITY STUFF                       *
 *-------------------------------------------------------------------*/

// Starts urb and waits for completion or timeout
Linus Torvalds's avatar
Linus Torvalds committed
1000
static int usb_start_wait_urb(struct urb *urb, int timeout, int* actual_length)
Linus Torvalds's avatar
Linus Torvalds committed
1001 1002
{
        DECLARE_WAITQUEUE(wait, current);
Linus Torvalds's avatar
Linus Torvalds committed
1003
	struct usb_api_data awd;
Linus Torvalds's avatar
Linus Torvalds committed
1004 1005
        int status;

Linus Torvalds's avatar
Linus Torvalds committed
1006 1007
        init_waitqueue_head(&awd.wqh);
        awd.done = 0;
1008

Linus Torvalds's avatar
Linus Torvalds committed
1009
        set_current_state(TASK_INTERRUPTIBLE);
Linus Torvalds's avatar
Linus Torvalds committed
1010
        add_wait_queue(&awd.wqh, &wait);
Linus Torvalds's avatar
Linus Torvalds committed
1011
        urb->context = &awd;
1012
        status = usb_submit_urb(urb, GFP_ATOMIC);
Linus Torvalds's avatar
Linus Torvalds committed
1013 1014 1015
        if (status) {
                // something went wrong
                usb_free_urb(urb);
Linus Torvalds's avatar
Linus Torvalds committed
1016
                set_current_state(TASK_RUNNING);
Linus Torvalds's avatar
Linus Torvalds committed
1017
                remove_wait_queue(&awd.wqh, &wait);
Linus Torvalds's avatar
Linus Torvalds committed
1018 1019 1020
                return status;
        }

Linus Torvalds's avatar
Linus Torvalds committed
1021 1022
	while (timeout && !awd.done)
		timeout = schedule_timeout(timeout);
Linus Torvalds's avatar
Linus Torvalds committed
1023

Linus Torvalds's avatar
Linus Torvalds committed
1024
        set_current_state(TASK_RUNNING);
Linus Torvalds's avatar
Linus Torvalds committed
1025
        remove_wait_queue(&awd.wqh, &wait);
Linus Torvalds's avatar
Linus Torvalds committed
1026

Linus Torvalds's avatar
Linus Torvalds committed
1027
        if (!timeout) {
Linus Torvalds's avatar
Linus Torvalds committed
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
                // timeout
                kaweth_warn("usb_control/bulk_msg: timeout");
                usb_unlink_urb(urb);  // remove urb safely
                status = -ETIMEDOUT;
        }
	else {
                status = urb->status;
	}

        if (actual_length) {
                *actual_length = urb->actual_length;
	}

        usb_free_urb(urb);
        return status;
}

/*-------------------------------------------------------------------*/
// returns status (negative) or length (positive)
int kaweth_internal_control_msg(struct usb_device *usb_dev, unsigned int pipe,
Linus Torvalds's avatar
Linus Torvalds committed
1048 1049
                            struct usb_ctrlrequest *cmd, void *data, int len,
			    int timeout)
Linus Torvalds's avatar
Linus Torvalds committed
1050
{
Linus Torvalds's avatar
Linus Torvalds committed
1051
        struct urb *urb;
Linus Torvalds's avatar
Linus Torvalds committed
1052 1053 1054
        int retv;
        int length;

1055
        urb = usb_alloc_urb(0, GFP_NOIO);
Linus Torvalds's avatar
Linus Torvalds committed
1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
        if (!urb)
                return -ENOMEM;

        FILL_CONTROL_URB(urb, usb_dev, pipe, (unsigned char*)cmd, data,
			 len, (usb_complete_t)usb_api_blocking_completion,0);

        retv = usb_start_wait_urb(urb, timeout, &length);
        if (retv < 0) {
                return retv;
	}
        else {
                return length;
	}
}


/****************************************************************
 *     kaweth_init
 ****************************************************************/
int __init kaweth_init(void)
{
	kaweth_dbg("Driver loading");
	return usb_register(&kaweth_driver);
}

/****************************************************************
 *     kaweth_exit
 ****************************************************************/
void __exit kaweth_exit(void)
{
	usb_deregister(&kaweth_driver);
}

module_init(kaweth_init);
module_exit(kaweth_exit);

Linus Torvalds's avatar
Linus Torvalds committed
1092 1093 1094 1095 1096 1097 1098