1 // SPDX-License-Identifier: (GPL-2.0+ OR BSD-3-Clause) 2 /* 3 * nozomi.c -- HSDPA driver Broadband Wireless Data Card - Globe Trotter 4 * 5 * Written by: Ulf Jakobsson, 6 * Jan Åkerfeldt, 7 * Stefan Thomasson, 8 * 9 * Maintained by: Paul Hardwick (p.hardwick@option.com) 10 * 11 * Patches: 12 * Locking code changes for Vodafone by Sphere Systems Ltd, 13 * Andrew Bird (ajb@spheresystems.co.uk ) 14 * & Phil Sanderson 15 * 16 * Source has been ported from an implementation made by Filip Aben @ Option 17 * 18 * -------------------------------------------------------------------------- 19 * 20 * Copyright (c) 2005,2006 Option Wireless Sweden AB 21 * Copyright (c) 2006 Sphere Systems Ltd 22 * Copyright (c) 2006 Option Wireless n/v 23 * All rights Reserved. 24 * 25 * -------------------------------------------------------------------------- 26 */ 27 28 /* Enable this to have a lot of debug printouts */ 29 #define DEBUG 30 31 #include <linux/kernel.h> 32 #include <linux/module.h> 33 #include <linux/pci.h> 34 #include <linux/ioport.h> 35 #include <linux/tty.h> 36 #include <linux/tty_driver.h> 37 #include <linux/tty_flip.h> 38 #include <linux/sched.h> 39 #include <linux/serial.h> 40 #include <linux/interrupt.h> 41 #include <linux/kmod.h> 42 #include <linux/init.h> 43 #include <linux/kfifo.h> 44 #include <linux/uaccess.h> 45 #include <linux/slab.h> 46 #include <asm/byteorder.h> 47 48 #include <linux/delay.h> 49 50 51 #define VERSION_STRING DRIVER_DESC " 2.1d" 52 53 /* Default debug printout level */ 54 #define NOZOMI_DEBUG_LEVEL 0x00 55 static int debug = NOZOMI_DEBUG_LEVEL; 56 module_param(debug, int, S_IRUGO | S_IWUSR); 57 58 /* Macros definitions */ 59 #define DBG_(lvl, fmt, args...) \ 60 do { \ 61 if (lvl & debug) \ 62 pr_debug("[%d] %s(): " fmt "\n", \ 63 __LINE__, __func__, ##args); \ 64 } while (0) 65 66 #define DBG1(args...) DBG_(0x01, ##args) 67 #define DBG2(args...) DBG_(0x02, ##args) 68 #define DBG3(args...) DBG_(0x04, ##args) 69 #define DBG4(args...) DBG_(0x08, ##args) 70 71 /* TODO: rewrite to optimize macros... */ 72 73 #define TMP_BUF_MAX 256 74 75 #define DUMP(buf__, len__) \ 76 do { \ 77 char tbuf[TMP_BUF_MAX] = {0}; \ 78 if (len__ > 1) { \ 79 u32 data_len = min_t(u32, len__, TMP_BUF_MAX); \ 80 strscpy(tbuf, buf__, data_len); \ 81 if (tbuf[data_len - 2] == '\r') \ 82 tbuf[data_len - 2] = 'r'; \ 83 DBG1("SENDING: '%s' (%d+n)", tbuf, len__); \ 84 } else { \ 85 DBG1("SENDING: '%s' (%d)", tbuf, len__); \ 86 } \ 87 } while (0) 88 89 /* Defines */ 90 #define NOZOMI_NAME "nozomi" 91 #define NOZOMI_NAME_TTY "nozomi_tty" 92 #define DRIVER_DESC "Nozomi driver" 93 94 #define NTTY_TTY_MAXMINORS 256 95 #define NTTY_FIFO_BUFFER_SIZE 8192 96 97 /* Must be power of 2 */ 98 #define FIFO_BUFFER_SIZE_UL 8192 99 100 /* Size of tmp send buffer to card */ 101 #define SEND_BUF_MAX 1024 102 #define RECEIVE_BUF_MAX 4 103 104 105 #define R_IIR 0x0000 /* Interrupt Identity Register */ 106 #define R_FCR 0x0000 /* Flow Control Register */ 107 #define R_IER 0x0004 /* Interrupt Enable Register */ 108 109 #define NOZOMI_CONFIG_MAGIC 0xEFEFFEFE 110 #define TOGGLE_VALID 0x0000 111 112 /* Definition of interrupt tokens */ 113 #define MDM_DL1 0x0001 114 #define MDM_UL1 0x0002 115 #define MDM_DL2 0x0004 116 #define MDM_UL2 0x0008 117 #define DIAG_DL1 0x0010 118 #define DIAG_DL2 0x0020 119 #define DIAG_UL 0x0040 120 #define APP1_DL 0x0080 121 #define APP1_UL 0x0100 122 #define APP2_DL 0x0200 123 #define APP2_UL 0x0400 124 #define CTRL_DL 0x0800 125 #define CTRL_UL 0x1000 126 #define RESET 0x8000 127 128 #define MDM_DL (MDM_DL1 | MDM_DL2) 129 #define MDM_UL (MDM_UL1 | MDM_UL2) 130 #define DIAG_DL (DIAG_DL1 | DIAG_DL2) 131 132 /* modem signal definition */ 133 #define CTRL_DSR 0x0001 134 #define CTRL_DCD 0x0002 135 #define CTRL_RI 0x0004 136 #define CTRL_CTS 0x0008 137 138 #define CTRL_DTR 0x0001 139 #define CTRL_RTS 0x0002 140 141 #define MAX_PORT 4 142 #define NOZOMI_MAX_PORTS 5 143 #define NOZOMI_MAX_CARDS (NTTY_TTY_MAXMINORS / MAX_PORT) 144 145 /* Type definitions */ 146 147 /* 148 * There are two types of nozomi cards, 149 * one with 2048 memory and with 8192 memory 150 */ 151 enum card_type { 152 F32_2 = 2048, /* 512 bytes downlink + uplink * 2 -> 2048 */ 153 F32_8 = 8192, /* 3072 bytes downl. + 1024 bytes uplink * 2 -> 8192 */ 154 }; 155 156 /* Initialization states a card can be in */ 157 enum card_state { 158 NOZOMI_STATE_UNKNOWN = 0, 159 NOZOMI_STATE_ENABLED = 1, /* pci device enabled */ 160 NOZOMI_STATE_ALLOCATED = 2, /* config setup done */ 161 NOZOMI_STATE_READY = 3, /* flowcontrols received */ 162 }; 163 164 /* Two different toggle channels exist */ 165 enum channel_type { 166 CH_A = 0, 167 CH_B = 1, 168 }; 169 170 /* Port definition for the card regarding flow control */ 171 enum ctrl_port_type { 172 CTRL_CMD = 0, 173 CTRL_MDM = 1, 174 CTRL_DIAG = 2, 175 CTRL_APP1 = 3, 176 CTRL_APP2 = 4, 177 CTRL_ERROR = -1, 178 }; 179 180 /* Ports that the nozomi has */ 181 enum port_type { 182 PORT_MDM = 0, 183 PORT_DIAG = 1, 184 PORT_APP1 = 2, 185 PORT_APP2 = 3, 186 PORT_CTRL = 4, 187 PORT_ERROR = -1, 188 }; 189 190 #ifdef __BIG_ENDIAN 191 /* Big endian */ 192 193 struct toggles { 194 unsigned int enabled:5; /* 195 * Toggle fields are valid if enabled is 0, 196 * else A-channels must always be used. 197 */ 198 unsigned int diag_dl:1; 199 unsigned int mdm_dl:1; 200 unsigned int mdm_ul:1; 201 } __attribute__ ((packed)); 202 203 /* Configuration table to read at startup of card */ 204 /* Is for now only needed during initialization phase */ 205 struct config_table { 206 u32 signature; 207 u16 product_information; 208 u16 version; 209 u8 pad3[3]; 210 struct toggles toggle; 211 u8 pad1[4]; 212 u16 dl_mdm_len1; /* 213 * If this is 64, it can hold 214 * 60 bytes + 4 that is length field 215 */ 216 u16 dl_start; 217 218 u16 dl_diag_len1; 219 u16 dl_mdm_len2; /* 220 * If this is 64, it can hold 221 * 60 bytes + 4 that is length field 222 */ 223 u16 dl_app1_len; 224 225 u16 dl_diag_len2; 226 u16 dl_ctrl_len; 227 u16 dl_app2_len; 228 u8 pad2[16]; 229 u16 ul_mdm_len1; 230 u16 ul_start; 231 u16 ul_diag_len; 232 u16 ul_mdm_len2; 233 u16 ul_app1_len; 234 u16 ul_app2_len; 235 u16 ul_ctrl_len; 236 } __attribute__ ((packed)); 237 238 /* This stores all control downlink flags */ 239 struct ctrl_dl { 240 u8 port; 241 unsigned int reserved:4; 242 unsigned int CTS:1; 243 unsigned int RI:1; 244 unsigned int DCD:1; 245 unsigned int DSR:1; 246 } __attribute__ ((packed)); 247 248 /* This stores all control uplink flags */ 249 struct ctrl_ul { 250 u8 port; 251 unsigned int reserved:6; 252 unsigned int RTS:1; 253 unsigned int DTR:1; 254 } __attribute__ ((packed)); 255 256 #else 257 /* Little endian */ 258 259 /* This represents the toggle information */ 260 struct toggles { 261 unsigned int mdm_ul:1; 262 unsigned int mdm_dl:1; 263 unsigned int diag_dl:1; 264 unsigned int enabled:5; /* 265 * Toggle fields are valid if enabled is 0, 266 * else A-channels must always be used. 267 */ 268 } __attribute__ ((packed)); 269 270 /* Configuration table to read at startup of card */ 271 struct config_table { 272 u32 signature; 273 u16 version; 274 u16 product_information; 275 struct toggles toggle; 276 u8 pad1[7]; 277 u16 dl_start; 278 u16 dl_mdm_len1; /* 279 * If this is 64, it can hold 280 * 60 bytes + 4 that is length field 281 */ 282 u16 dl_mdm_len2; 283 u16 dl_diag_len1; 284 u16 dl_diag_len2; 285 u16 dl_app1_len; 286 u16 dl_app2_len; 287 u16 dl_ctrl_len; 288 u8 pad2[16]; 289 u16 ul_start; 290 u16 ul_mdm_len2; 291 u16 ul_mdm_len1; 292 u16 ul_diag_len; 293 u16 ul_app1_len; 294 u16 ul_app2_len; 295 u16 ul_ctrl_len; 296 } __attribute__ ((packed)); 297 298 /* This stores all control downlink flags */ 299 struct ctrl_dl { 300 unsigned int DSR:1; 301 unsigned int DCD:1; 302 unsigned int RI:1; 303 unsigned int CTS:1; 304 unsigned int reserved:4; 305 u8 port; 306 } __attribute__ ((packed)); 307 308 /* This stores all control uplink flags */ 309 struct ctrl_ul { 310 unsigned int DTR:1; 311 unsigned int RTS:1; 312 unsigned int reserved:6; 313 u8 port; 314 } __attribute__ ((packed)); 315 #endif 316 317 /* This holds all information that is needed regarding a port */ 318 struct port { 319 struct tty_port port; 320 u8 update_flow_control; 321 struct ctrl_ul ctrl_ul; 322 struct ctrl_dl ctrl_dl; 323 struct kfifo fifo_ul; 324 void __iomem *dl_addr[2]; 325 u32 dl_size[2]; 326 u8 toggle_dl; 327 void __iomem *ul_addr[2]; 328 u32 ul_size[2]; 329 u8 toggle_ul; 330 u16 token_dl; 331 332 wait_queue_head_t tty_wait; 333 struct async_icount tty_icount; 334 335 struct nozomi *dc; 336 }; 337 338 /* Private data one for each card in the system */ 339 struct nozomi { 340 void __iomem *base_addr; 341 unsigned long flip; 342 343 /* Pointers to registers */ 344 void __iomem *reg_iir; 345 void __iomem *reg_fcr; 346 void __iomem *reg_ier; 347 348 u16 last_ier; 349 enum card_type card_type; 350 struct config_table config_table; /* Configuration table */ 351 struct pci_dev *pdev; 352 struct port port[NOZOMI_MAX_PORTS]; 353 u8 *send_buf; 354 355 spinlock_t spin_mutex; /* secures access to registers and tty */ 356 357 unsigned int index_start; 358 enum card_state state; 359 u32 open_ttys; 360 }; 361 362 /* This is a data packet that is read or written to/from card */ 363 struct buffer { 364 u32 size; /* size is the length of the data buffer */ 365 u8 *data; 366 } __attribute__ ((packed)); 367 368 /* Global variables */ 369 static const struct pci_device_id nozomi_pci_tbl[] = { 370 {PCI_DEVICE(0x1931, 0x000c)}, /* Nozomi HSDPA */ 371 {}, 372 }; 373 374 MODULE_DEVICE_TABLE(pci, nozomi_pci_tbl); 375 376 static struct nozomi *ndevs[NOZOMI_MAX_CARDS]; 377 static struct tty_driver *ntty_driver; 378 379 static const struct tty_port_operations noz_tty_port_ops; 380 381 /* 382 * find card by tty_index 383 */ 384 static inline struct nozomi *get_dc_by_tty(const struct tty_struct *tty) 385 { 386 return tty ? ndevs[tty->index / MAX_PORT] : NULL; 387 } 388 389 static inline struct port *get_port_by_tty(const struct tty_struct *tty) 390 { 391 struct nozomi *ndev = get_dc_by_tty(tty); 392 return ndev ? &ndev->port[tty->index % MAX_PORT] : NULL; 393 } 394 395 /* 396 * TODO: 397 * -Optimize 398 * -Rewrite cleaner 399 */ 400 401 static void read_mem32(u32 *buf, const void __iomem *mem_addr_start, 402 u32 size_bytes) 403 { 404 u32 i = 0; 405 const u32 __iomem *ptr = mem_addr_start; 406 u16 *buf16; 407 408 if (unlikely(!ptr || !buf)) 409 goto out; 410 411 /* shortcut for extremely often used cases */ 412 switch (size_bytes) { 413 case 2: /* 2 bytes */ 414 buf16 = (u16 *) buf; 415 *buf16 = __le16_to_cpu(readw(ptr)); 416 goto out; 417 break; 418 case 4: /* 4 bytes */ 419 *(buf) = __le32_to_cpu(readl(ptr)); 420 goto out; 421 break; 422 } 423 424 while (i < size_bytes) { 425 if (size_bytes - i == 2) { 426 /* Handle 2 bytes in the end */ 427 buf16 = (u16 *) buf; 428 *(buf16) = __le16_to_cpu(readw(ptr)); 429 i += 2; 430 } else { 431 /* Read 4 bytes */ 432 *(buf) = __le32_to_cpu(readl(ptr)); 433 i += 4; 434 } 435 buf++; 436 ptr++; 437 } 438 out: 439 return; 440 } 441 442 /* 443 * TODO: 444 * -Optimize 445 * -Rewrite cleaner 446 */ 447 static u32 write_mem32(void __iomem *mem_addr_start, const u32 *buf, 448 u32 size_bytes) 449 { 450 u32 i = 0; 451 u32 __iomem *ptr = mem_addr_start; 452 const u16 *buf16; 453 454 if (unlikely(!ptr || !buf)) 455 return 0; 456 457 /* shortcut for extremely often used cases */ 458 switch (size_bytes) { 459 case 2: /* 2 bytes */ 460 buf16 = (const u16 *)buf; 461 writew(__cpu_to_le16(*buf16), ptr); 462 return 2; 463 break; 464 case 1: /* 465 * also needs to write 4 bytes in this case 466 * so falling through.. 467 */ 468 case 4: /* 4 bytes */ 469 writel(__cpu_to_le32(*buf), ptr); 470 return 4; 471 break; 472 } 473 474 while (i < size_bytes) { 475 if (size_bytes - i == 2) { 476 /* 2 bytes */ 477 buf16 = (const u16 *)buf; 478 writew(__cpu_to_le16(*buf16), ptr); 479 i += 2; 480 } else { 481 /* 4 bytes */ 482 writel(__cpu_to_le32(*buf), ptr); 483 i += 4; 484 } 485 buf++; 486 ptr++; 487 } 488 return i; 489 } 490 491 /* Setup pointers to different channels and also setup buffer sizes. */ 492 static void nozomi_setup_memory(struct nozomi *dc) 493 { 494 void __iomem *offset = dc->base_addr + dc->config_table.dl_start; 495 /* The length reported is including the length field of 4 bytes, 496 * hence subtract with 4. 497 */ 498 const u16 buff_offset = 4; 499 500 /* Modem port dl configuration */ 501 dc->port[PORT_MDM].dl_addr[CH_A] = offset; 502 dc->port[PORT_MDM].dl_addr[CH_B] = 503 (offset += dc->config_table.dl_mdm_len1); 504 dc->port[PORT_MDM].dl_size[CH_A] = 505 dc->config_table.dl_mdm_len1 - buff_offset; 506 dc->port[PORT_MDM].dl_size[CH_B] = 507 dc->config_table.dl_mdm_len2 - buff_offset; 508 509 /* Diag port dl configuration */ 510 dc->port[PORT_DIAG].dl_addr[CH_A] = 511 (offset += dc->config_table.dl_mdm_len2); 512 dc->port[PORT_DIAG].dl_size[CH_A] = 513 dc->config_table.dl_diag_len1 - buff_offset; 514 dc->port[PORT_DIAG].dl_addr[CH_B] = 515 (offset += dc->config_table.dl_diag_len1); 516 dc->port[PORT_DIAG].dl_size[CH_B] = 517 dc->config_table.dl_diag_len2 - buff_offset; 518 519 /* App1 port dl configuration */ 520 dc->port[PORT_APP1].dl_addr[CH_A] = 521 (offset += dc->config_table.dl_diag_len2); 522 dc->port[PORT_APP1].dl_size[CH_A] = 523 dc->config_table.dl_app1_len - buff_offset; 524 525 /* App2 port dl configuration */ 526 dc->port[PORT_APP2].dl_addr[CH_A] = 527 (offset += dc->config_table.dl_app1_len); 528 dc->port[PORT_APP2].dl_size[CH_A] = 529 dc->config_table.dl_app2_len - buff_offset; 530 531 /* Ctrl dl configuration */ 532 dc->port[PORT_CTRL].dl_addr[CH_A] = 533 (offset += dc->config_table.dl_app2_len); 534 dc->port[PORT_CTRL].dl_size[CH_A] = 535 dc->config_table.dl_ctrl_len - buff_offset; 536 537 offset = dc->base_addr + dc->config_table.ul_start; 538 539 /* Modem Port ul configuration */ 540 dc->port[PORT_MDM].ul_addr[CH_A] = offset; 541 dc->port[PORT_MDM].ul_size[CH_A] = 542 dc->config_table.ul_mdm_len1 - buff_offset; 543 dc->port[PORT_MDM].ul_addr[CH_B] = 544 (offset += dc->config_table.ul_mdm_len1); 545 dc->port[PORT_MDM].ul_size[CH_B] = 546 dc->config_table.ul_mdm_len2 - buff_offset; 547 548 /* Diag port ul configuration */ 549 dc->port[PORT_DIAG].ul_addr[CH_A] = 550 (offset += dc->config_table.ul_mdm_len2); 551 dc->port[PORT_DIAG].ul_size[CH_A] = 552 dc->config_table.ul_diag_len - buff_offset; 553 554 /* App1 port ul configuration */ 555 dc->port[PORT_APP1].ul_addr[CH_A] = 556 (offset += dc->config_table.ul_diag_len); 557 dc->port[PORT_APP1].ul_size[CH_A] = 558 dc->config_table.ul_app1_len - buff_offset; 559 560 /* App2 port ul configuration */ 561 dc->port[PORT_APP2].ul_addr[CH_A] = 562 (offset += dc->config_table.ul_app1_len); 563 dc->port[PORT_APP2].ul_size[CH_A] = 564 dc->config_table.ul_app2_len - buff_offset; 565 566 /* Ctrl ul configuration */ 567 dc->port[PORT_CTRL].ul_addr[CH_A] = 568 (offset += dc->config_table.ul_app2_len); 569 dc->port[PORT_CTRL].ul_size[CH_A] = 570 dc->config_table.ul_ctrl_len - buff_offset; 571 } 572 573 /* Dump config table under initalization phase */ 574 #ifdef DEBUG 575 static void dump_table(const struct nozomi *dc) 576 { 577 DBG3("signature: 0x%08X", dc->config_table.signature); 578 DBG3("version: 0x%04X", dc->config_table.version); 579 DBG3("product_information: 0x%04X", \ 580 dc->config_table.product_information); 581 DBG3("toggle enabled: %d", dc->config_table.toggle.enabled); 582 DBG3("toggle up_mdm: %d", dc->config_table.toggle.mdm_ul); 583 DBG3("toggle dl_mdm: %d", dc->config_table.toggle.mdm_dl); 584 DBG3("toggle dl_dbg: %d", dc->config_table.toggle.diag_dl); 585 586 DBG3("dl_start: 0x%04X", dc->config_table.dl_start); 587 DBG3("dl_mdm_len0: 0x%04X, %d", dc->config_table.dl_mdm_len1, 588 dc->config_table.dl_mdm_len1); 589 DBG3("dl_mdm_len1: 0x%04X, %d", dc->config_table.dl_mdm_len2, 590 dc->config_table.dl_mdm_len2); 591 DBG3("dl_diag_len0: 0x%04X, %d", dc->config_table.dl_diag_len1, 592 dc->config_table.dl_diag_len1); 593 DBG3("dl_diag_len1: 0x%04X, %d", dc->config_table.dl_diag_len2, 594 dc->config_table.dl_diag_len2); 595 DBG3("dl_app1_len: 0x%04X, %d", dc->config_table.dl_app1_len, 596 dc->config_table.dl_app1_len); 597 DBG3("dl_app2_len: 0x%04X, %d", dc->config_table.dl_app2_len, 598 dc->config_table.dl_app2_len); 599 DBG3("dl_ctrl_len: 0x%04X, %d", dc->config_table.dl_ctrl_len, 600 dc->config_table.dl_ctrl_len); 601 DBG3("ul_start: 0x%04X, %d", dc->config_table.ul_start, 602 dc->config_table.ul_start); 603 DBG3("ul_mdm_len[0]: 0x%04X, %d", dc->config_table.ul_mdm_len1, 604 dc->config_table.ul_mdm_len1); 605 DBG3("ul_mdm_len[1]: 0x%04X, %d", dc->config_table.ul_mdm_len2, 606 dc->config_table.ul_mdm_len2); 607 DBG3("ul_diag_len: 0x%04X, %d", dc->config_table.ul_diag_len, 608 dc->config_table.ul_diag_len); 609 DBG3("ul_app1_len: 0x%04X, %d", dc->config_table.ul_app1_len, 610 dc->config_table.ul_app1_len); 611 DBG3("ul_app2_len: 0x%04X, %d", dc->config_table.ul_app2_len, 612 dc->config_table.ul_app2_len); 613 DBG3("ul_ctrl_len: 0x%04X, %d", dc->config_table.ul_ctrl_len, 614 dc->config_table.ul_ctrl_len); 615 } 616 #else 617 static inline void dump_table(const struct nozomi *dc) { } 618 #endif 619 620 /* 621 * Read configuration table from card under intalization phase 622 * Returns 1 if ok, else 0 623 */ 624 static int nozomi_read_config_table(struct nozomi *dc) 625 { 626 read_mem32((u32 *) &dc->config_table, dc->base_addr + 0, 627 sizeof(struct config_table)); 628 629 if (dc->config_table.signature != NOZOMI_CONFIG_MAGIC) { 630 dev_err(&dc->pdev->dev, "ConfigTable Bad! 0x%08X != 0x%08X\n", 631 dc->config_table.signature, NOZOMI_CONFIG_MAGIC); 632 return 0; 633 } 634 635 if ((dc->config_table.version == 0) 636 || (dc->config_table.toggle.enabled == TOGGLE_VALID)) { 637 int i; 638 DBG1("Second phase, configuring card"); 639 640 nozomi_setup_memory(dc); 641 642 dc->port[PORT_MDM].toggle_ul = dc->config_table.toggle.mdm_ul; 643 dc->port[PORT_MDM].toggle_dl = dc->config_table.toggle.mdm_dl; 644 dc->port[PORT_DIAG].toggle_dl = dc->config_table.toggle.diag_dl; 645 DBG1("toggle ports: MDM UL:%d MDM DL:%d, DIAG DL:%d", 646 dc->port[PORT_MDM].toggle_ul, 647 dc->port[PORT_MDM].toggle_dl, dc->port[PORT_DIAG].toggle_dl); 648 649 dump_table(dc); 650 651 for (i = PORT_MDM; i < MAX_PORT; i++) { 652 memset(&dc->port[i].ctrl_dl, 0, sizeof(struct ctrl_dl)); 653 memset(&dc->port[i].ctrl_ul, 0, sizeof(struct ctrl_ul)); 654 } 655 656 /* Enable control channel */ 657 dc->last_ier = dc->last_ier | CTRL_DL; 658 writew(dc->last_ier, dc->reg_ier); 659 660 dc->state = NOZOMI_STATE_ALLOCATED; 661 dev_info(&dc->pdev->dev, "Initialization OK!\n"); 662 return 1; 663 } 664 665 if ((dc->config_table.version > 0) 666 && (dc->config_table.toggle.enabled != TOGGLE_VALID)) { 667 u32 offset = 0; 668 DBG1("First phase: pushing upload buffers, clearing download"); 669 670 dev_info(&dc->pdev->dev, "Version of card: %d\n", 671 dc->config_table.version); 672 673 /* Here we should disable all I/O over F32. */ 674 nozomi_setup_memory(dc); 675 676 /* 677 * We should send ALL channel pair tokens back along 678 * with reset token 679 */ 680 681 /* push upload modem buffers */ 682 write_mem32(dc->port[PORT_MDM].ul_addr[CH_A], 683 (u32 *) &offset, 4); 684 write_mem32(dc->port[PORT_MDM].ul_addr[CH_B], 685 (u32 *) &offset, 4); 686 687 writew(MDM_UL | DIAG_DL | MDM_DL, dc->reg_fcr); 688 689 DBG1("First phase done"); 690 } 691 692 return 1; 693 } 694 695 /* Enable uplink interrupts */ 696 static void enable_transmit_ul(enum port_type port, struct nozomi *dc) 697 { 698 static const u16 mask[] = {MDM_UL, DIAG_UL, APP1_UL, APP2_UL, CTRL_UL}; 699 700 if (port < NOZOMI_MAX_PORTS) { 701 dc->last_ier |= mask[port]; 702 writew(dc->last_ier, dc->reg_ier); 703 } else { 704 dev_err(&dc->pdev->dev, "Called with wrong port?\n"); 705 } 706 } 707 708 /* Disable uplink interrupts */ 709 static void disable_transmit_ul(enum port_type port, struct nozomi *dc) 710 { 711 static const u16 mask[] = 712 {~MDM_UL, ~DIAG_UL, ~APP1_UL, ~APP2_UL, ~CTRL_UL}; 713 714 if (port < NOZOMI_MAX_PORTS) { 715 dc->last_ier &= mask[port]; 716 writew(dc->last_ier, dc->reg_ier); 717 } else { 718 dev_err(&dc->pdev->dev, "Called with wrong port?\n"); 719 } 720 } 721 722 /* Enable downlink interrupts */ 723 static void enable_transmit_dl(enum port_type port, struct nozomi *dc) 724 { 725 static const u16 mask[] = {MDM_DL, DIAG_DL, APP1_DL, APP2_DL, CTRL_DL}; 726 727 if (port < NOZOMI_MAX_PORTS) { 728 dc->last_ier |= mask[port]; 729 writew(dc->last_ier, dc->reg_ier); 730 } else { 731 dev_err(&dc->pdev->dev, "Called with wrong port?\n"); 732 } 733 } 734 735 /* Disable downlink interrupts */ 736 static void disable_transmit_dl(enum port_type port, struct nozomi *dc) 737 { 738 static const u16 mask[] = 739 {~MDM_DL, ~DIAG_DL, ~APP1_DL, ~APP2_DL, ~CTRL_DL}; 740 741 if (port < NOZOMI_MAX_PORTS) { 742 dc->last_ier &= mask[port]; 743 writew(dc->last_ier, dc->reg_ier); 744 } else { 745 dev_err(&dc->pdev->dev, "Called with wrong port?\n"); 746 } 747 } 748 749 /* 750 * Return 1 - send buffer to card and ack. 751 * Return 0 - don't ack, don't send buffer to card. 752 */ 753 static int send_data(enum port_type index, struct nozomi *dc) 754 { 755 u32 size = 0; 756 struct port *port = &dc->port[index]; 757 const u8 toggle = port->toggle_ul; 758 void __iomem *addr = port->ul_addr[toggle]; 759 const u32 ul_size = port->ul_size[toggle]; 760 761 /* Get data from tty and place in buf for now */ 762 size = kfifo_out(&port->fifo_ul, dc->send_buf, 763 ul_size < SEND_BUF_MAX ? ul_size : SEND_BUF_MAX); 764 765 if (size == 0) { 766 DBG4("No more data to send, disable link:"); 767 return 0; 768 } 769 770 /* DUMP(buf, size); */ 771 772 /* Write length + data */ 773 write_mem32(addr, (u32 *) &size, 4); 774 write_mem32(addr + 4, (u32 *) dc->send_buf, size); 775 776 tty_port_tty_wakeup(&port->port); 777 778 return 1; 779 } 780 781 /* If all data has been read, return 1, else 0 */ 782 static int receive_data(enum port_type index, struct nozomi *dc) 783 { 784 u8 buf[RECEIVE_BUF_MAX] = { 0 }; 785 int size; 786 u32 offset = 4; 787 struct port *port = &dc->port[index]; 788 void __iomem *addr = port->dl_addr[port->toggle_dl]; 789 struct tty_struct *tty = tty_port_tty_get(&port->port); 790 int i, ret; 791 792 size = __le32_to_cpu(readl(addr)); 793 /* DBG1( "%d bytes port: %d", size, index); */ 794 795 if (tty && tty_throttled(tty)) { 796 DBG1("No room in tty, don't read data, don't ack interrupt, " 797 "disable interrupt"); 798 799 /* disable interrupt in downlink... */ 800 disable_transmit_dl(index, dc); 801 ret = 0; 802 goto put; 803 } 804 805 if (unlikely(size == 0)) { 806 dev_err(&dc->pdev->dev, "size == 0?\n"); 807 ret = 1; 808 goto put; 809 } 810 811 while (size > 0) { 812 read_mem32((u32 *) buf, addr + offset, RECEIVE_BUF_MAX); 813 814 if (size == 1) { 815 tty_insert_flip_char(&port->port, buf[0], TTY_NORMAL); 816 size = 0; 817 } else if (size < RECEIVE_BUF_MAX) { 818 size -= tty_insert_flip_string(&port->port, 819 (char *)buf, size); 820 } else { 821 i = tty_insert_flip_string(&port->port, 822 (char *)buf, RECEIVE_BUF_MAX); 823 size -= i; 824 offset += i; 825 } 826 } 827 828 set_bit(index, &dc->flip); 829 ret = 1; 830 put: 831 tty_kref_put(tty); 832 return ret; 833 } 834 835 /* Debug for interrupts */ 836 #ifdef DEBUG 837 static char *interrupt2str(u16 interrupt) 838 { 839 static char buf[TMP_BUF_MAX]; 840 char *p = buf; 841 842 if (interrupt & MDM_DL1) 843 p += scnprintf(p, TMP_BUF_MAX, "MDM_DL1 "); 844 if (interrupt & MDM_DL2) 845 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "MDM_DL2 "); 846 if (interrupt & MDM_UL1) 847 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "MDM_UL1 "); 848 if (interrupt & MDM_UL2) 849 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "MDM_UL2 "); 850 if (interrupt & DIAG_DL1) 851 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "DIAG_DL1 "); 852 if (interrupt & DIAG_DL2) 853 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "DIAG_DL2 "); 854 855 if (interrupt & DIAG_UL) 856 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "DIAG_UL "); 857 858 if (interrupt & APP1_DL) 859 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP1_DL "); 860 if (interrupt & APP2_DL) 861 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP2_DL "); 862 863 if (interrupt & APP1_UL) 864 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP1_UL "); 865 if (interrupt & APP2_UL) 866 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "APP2_UL "); 867 868 if (interrupt & CTRL_DL) 869 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "CTRL_DL "); 870 if (interrupt & CTRL_UL) 871 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "CTRL_UL "); 872 873 if (interrupt & RESET) 874 p += scnprintf(p, TMP_BUF_MAX - (p - buf), "RESET "); 875 876 return buf; 877 } 878 #endif 879 880 /* 881 * Receive flow control 882 * Return 1 - If ok, else 0 883 */ 884 static int receive_flow_control(struct nozomi *dc) 885 { 886 enum port_type port = PORT_MDM; 887 struct ctrl_dl ctrl_dl; 888 struct ctrl_dl old_ctrl; 889 u16 enable_ier = 0; 890 891 read_mem32((u32 *) &ctrl_dl, dc->port[PORT_CTRL].dl_addr[CH_A], 2); 892 893 switch (ctrl_dl.port) { 894 case CTRL_CMD: 895 DBG1("The Base Band sends this value as a response to a " 896 "request for IMSI detach sent over the control " 897 "channel uplink (see section 7.6.1)."); 898 break; 899 case CTRL_MDM: 900 port = PORT_MDM; 901 enable_ier = MDM_DL; 902 break; 903 case CTRL_DIAG: 904 port = PORT_DIAG; 905 enable_ier = DIAG_DL; 906 break; 907 case CTRL_APP1: 908 port = PORT_APP1; 909 enable_ier = APP1_DL; 910 break; 911 case CTRL_APP2: 912 port = PORT_APP2; 913 enable_ier = APP2_DL; 914 if (dc->state == NOZOMI_STATE_ALLOCATED) { 915 /* 916 * After card initialization the flow control 917 * received for APP2 is always the last 918 */ 919 dc->state = NOZOMI_STATE_READY; 920 dev_info(&dc->pdev->dev, "Device READY!\n"); 921 } 922 break; 923 default: 924 dev_err(&dc->pdev->dev, 925 "ERROR: flow control received for non-existing port\n"); 926 return 0; 927 } 928 929 DBG1("0x%04X->0x%04X", *((u16 *)&dc->port[port].ctrl_dl), 930 *((u16 *)&ctrl_dl)); 931 932 old_ctrl = dc->port[port].ctrl_dl; 933 dc->port[port].ctrl_dl = ctrl_dl; 934 935 if (old_ctrl.CTS == 1 && ctrl_dl.CTS == 0) { 936 DBG1("Disable interrupt (0x%04X) on port: %d", 937 enable_ier, port); 938 disable_transmit_ul(port, dc); 939 940 } else if (old_ctrl.CTS == 0 && ctrl_dl.CTS == 1) { 941 942 if (kfifo_len(&dc->port[port].fifo_ul)) { 943 DBG1("Enable interrupt (0x%04X) on port: %d", 944 enable_ier, port); 945 DBG1("Data in buffer [%d], enable transmit! ", 946 kfifo_len(&dc->port[port].fifo_ul)); 947 enable_transmit_ul(port, dc); 948 } else { 949 DBG1("No data in buffer..."); 950 } 951 } 952 953 if (*(u16 *)&old_ctrl == *(u16 *)&ctrl_dl) { 954 DBG1(" No change in mctrl"); 955 return 1; 956 } 957 /* Update statistics */ 958 if (old_ctrl.CTS != ctrl_dl.CTS) 959 dc->port[port].tty_icount.cts++; 960 if (old_ctrl.DSR != ctrl_dl.DSR) 961 dc->port[port].tty_icount.dsr++; 962 if (old_ctrl.RI != ctrl_dl.RI) 963 dc->port[port].tty_icount.rng++; 964 if (old_ctrl.DCD != ctrl_dl.DCD) 965 dc->port[port].tty_icount.dcd++; 966 967 wake_up_interruptible(&dc->port[port].tty_wait); 968 969 DBG1("port: %d DCD(%d), CTS(%d), RI(%d), DSR(%d)", 970 port, 971 dc->port[port].tty_icount.dcd, dc->port[port].tty_icount.cts, 972 dc->port[port].tty_icount.rng, dc->port[port].tty_icount.dsr); 973 974 return 1; 975 } 976 977 static enum ctrl_port_type port2ctrl(enum port_type port, 978 const struct nozomi *dc) 979 { 980 switch (port) { 981 case PORT_MDM: 982 return CTRL_MDM; 983 case PORT_DIAG: 984 return CTRL_DIAG; 985 case PORT_APP1: 986 return CTRL_APP1; 987 case PORT_APP2: 988 return CTRL_APP2; 989 default: 990 dev_err(&dc->pdev->dev, 991 "ERROR: send flow control " \ 992 "received for non-existing port\n"); 993 } 994 return CTRL_ERROR; 995 } 996 997 /* 998 * Send flow control, can only update one channel at a time 999 * Return 0 - If we have updated all flow control 1000 * Return 1 - If we need to update more flow control, ack current enable more 1001 */ 1002 static int send_flow_control(struct nozomi *dc) 1003 { 1004 u32 i, more_flow_control_to_be_updated = 0; 1005 u16 *ctrl; 1006 1007 for (i = PORT_MDM; i < MAX_PORT; i++) { 1008 if (dc->port[i].update_flow_control) { 1009 if (more_flow_control_to_be_updated) { 1010 /* We have more flow control to be updated */ 1011 return 1; 1012 } 1013 dc->port[i].ctrl_ul.port = port2ctrl(i, dc); 1014 ctrl = (u16 *)&dc->port[i].ctrl_ul; 1015 write_mem32(dc->port[PORT_CTRL].ul_addr[0], \ 1016 (u32 *) ctrl, 2); 1017 dc->port[i].update_flow_control = 0; 1018 more_flow_control_to_be_updated = 1; 1019 } 1020 } 1021 return 0; 1022 } 1023 1024 /* 1025 * Handle downlink data, ports that are handled are modem and diagnostics 1026 * Return 1 - ok 1027 * Return 0 - toggle fields are out of sync 1028 */ 1029 static int handle_data_dl(struct nozomi *dc, enum port_type port, u8 *toggle, 1030 u16 read_iir, u16 mask1, u16 mask2) 1031 { 1032 if (*toggle == 0 && read_iir & mask1) { 1033 if (receive_data(port, dc)) { 1034 writew(mask1, dc->reg_fcr); 1035 *toggle = !(*toggle); 1036 } 1037 1038 if (read_iir & mask2) { 1039 if (receive_data(port, dc)) { 1040 writew(mask2, dc->reg_fcr); 1041 *toggle = !(*toggle); 1042 } 1043 } 1044 } else if (*toggle == 1 && read_iir & mask2) { 1045 if (receive_data(port, dc)) { 1046 writew(mask2, dc->reg_fcr); 1047 *toggle = !(*toggle); 1048 } 1049 1050 if (read_iir & mask1) { 1051 if (receive_data(port, dc)) { 1052 writew(mask1, dc->reg_fcr); 1053 *toggle = !(*toggle); 1054 } 1055 } 1056 } else { 1057 dev_err(&dc->pdev->dev, "port out of sync!, toggle:%d\n", 1058 *toggle); 1059 return 0; 1060 } 1061 return 1; 1062 } 1063 1064 /* 1065 * Handle uplink data, this is currently for the modem port 1066 * Return 1 - ok 1067 * Return 0 - toggle field are out of sync 1068 */ 1069 static int handle_data_ul(struct nozomi *dc, enum port_type port, u16 read_iir) 1070 { 1071 u8 *toggle = &(dc->port[port].toggle_ul); 1072 1073 if (*toggle == 0 && read_iir & MDM_UL1) { 1074 dc->last_ier &= ~MDM_UL; 1075 writew(dc->last_ier, dc->reg_ier); 1076 if (send_data(port, dc)) { 1077 writew(MDM_UL1, dc->reg_fcr); 1078 dc->last_ier = dc->last_ier | MDM_UL; 1079 writew(dc->last_ier, dc->reg_ier); 1080 *toggle = !*toggle; 1081 } 1082 1083 if (read_iir & MDM_UL2) { 1084 dc->last_ier &= ~MDM_UL; 1085 writew(dc->last_ier, dc->reg_ier); 1086 if (send_data(port, dc)) { 1087 writew(MDM_UL2, dc->reg_fcr); 1088 dc->last_ier = dc->last_ier | MDM_UL; 1089 writew(dc->last_ier, dc->reg_ier); 1090 *toggle = !*toggle; 1091 } 1092 } 1093 1094 } else if (*toggle == 1 && read_iir & MDM_UL2) { 1095 dc->last_ier &= ~MDM_UL; 1096 writew(dc->last_ier, dc->reg_ier); 1097 if (send_data(port, dc)) { 1098 writew(MDM_UL2, dc->reg_fcr); 1099 dc->last_ier = dc->last_ier | MDM_UL; 1100 writew(dc->last_ier, dc->reg_ier); 1101 *toggle = !*toggle; 1102 } 1103 1104 if (read_iir & MDM_UL1) { 1105 dc->last_ier &= ~MDM_UL; 1106 writew(dc->last_ier, dc->reg_ier); 1107 if (send_data(port, dc)) { 1108 writew(MDM_UL1, dc->reg_fcr); 1109 dc->last_ier = dc->last_ier | MDM_UL; 1110 writew(dc->last_ier, dc->reg_ier); 1111 *toggle = !*toggle; 1112 } 1113 } 1114 } else { 1115 writew(read_iir & MDM_UL, dc->reg_fcr); 1116 dev_err(&dc->pdev->dev, "port out of sync!\n"); 1117 return 0; 1118 } 1119 return 1; 1120 } 1121 1122 static irqreturn_t interrupt_handler(int irq, void *dev_id) 1123 { 1124 struct nozomi *dc = dev_id; 1125 unsigned int a; 1126 u16 read_iir; 1127 1128 if (!dc) 1129 return IRQ_NONE; 1130 1131 spin_lock(&dc->spin_mutex); 1132 read_iir = readw(dc->reg_iir); 1133 1134 /* Card removed */ 1135 if (read_iir == (u16)-1) 1136 goto none; 1137 /* 1138 * Just handle interrupt enabled in IER 1139 * (by masking with dc->last_ier) 1140 */ 1141 read_iir &= dc->last_ier; 1142 1143 if (read_iir == 0) 1144 goto none; 1145 1146 1147 DBG4("%s irq:0x%04X, prev:0x%04X", interrupt2str(read_iir), read_iir, 1148 dc->last_ier); 1149 1150 if (read_iir & RESET) { 1151 if (unlikely(!nozomi_read_config_table(dc))) { 1152 dc->last_ier = 0x0; 1153 writew(dc->last_ier, dc->reg_ier); 1154 dev_err(&dc->pdev->dev, "Could not read status from " 1155 "card, we should disable interface\n"); 1156 } else { 1157 writew(RESET, dc->reg_fcr); 1158 } 1159 /* No more useful info if this was the reset interrupt. */ 1160 goto exit_handler; 1161 } 1162 if (read_iir & CTRL_UL) { 1163 DBG1("CTRL_UL"); 1164 dc->last_ier &= ~CTRL_UL; 1165 writew(dc->last_ier, dc->reg_ier); 1166 if (send_flow_control(dc)) { 1167 writew(CTRL_UL, dc->reg_fcr); 1168 dc->last_ier = dc->last_ier | CTRL_UL; 1169 writew(dc->last_ier, dc->reg_ier); 1170 } 1171 } 1172 if (read_iir & CTRL_DL) { 1173 receive_flow_control(dc); 1174 writew(CTRL_DL, dc->reg_fcr); 1175 } 1176 if (read_iir & MDM_DL) { 1177 if (!handle_data_dl(dc, PORT_MDM, 1178 &(dc->port[PORT_MDM].toggle_dl), read_iir, 1179 MDM_DL1, MDM_DL2)) { 1180 dev_err(&dc->pdev->dev, "MDM_DL out of sync!\n"); 1181 goto exit_handler; 1182 } 1183 } 1184 if (read_iir & MDM_UL) { 1185 if (!handle_data_ul(dc, PORT_MDM, read_iir)) { 1186 dev_err(&dc->pdev->dev, "MDM_UL out of sync!\n"); 1187 goto exit_handler; 1188 } 1189 } 1190 if (read_iir & DIAG_DL) { 1191 if (!handle_data_dl(dc, PORT_DIAG, 1192 &(dc->port[PORT_DIAG].toggle_dl), read_iir, 1193 DIAG_DL1, DIAG_DL2)) { 1194 dev_err(&dc->pdev->dev, "DIAG_DL out of sync!\n"); 1195 goto exit_handler; 1196 } 1197 } 1198 if (read_iir & DIAG_UL) { 1199 dc->last_ier &= ~DIAG_UL; 1200 writew(dc->last_ier, dc->reg_ier); 1201 if (send_data(PORT_DIAG, dc)) { 1202 writew(DIAG_UL, dc->reg_fcr); 1203 dc->last_ier = dc->last_ier | DIAG_UL; 1204 writew(dc->last_ier, dc->reg_ier); 1205 } 1206 } 1207 if (read_iir & APP1_DL) { 1208 if (receive_data(PORT_APP1, dc)) 1209 writew(APP1_DL, dc->reg_fcr); 1210 } 1211 if (read_iir & APP1_UL) { 1212 dc->last_ier &= ~APP1_UL; 1213 writew(dc->last_ier, dc->reg_ier); 1214 if (send_data(PORT_APP1, dc)) { 1215 writew(APP1_UL, dc->reg_fcr); 1216 dc->last_ier = dc->last_ier | APP1_UL; 1217 writew(dc->last_ier, dc->reg_ier); 1218 } 1219 } 1220 if (read_iir & APP2_DL) { 1221 if (receive_data(PORT_APP2, dc)) 1222 writew(APP2_DL, dc->reg_fcr); 1223 } 1224 if (read_iir & APP2_UL) { 1225 dc->last_ier &= ~APP2_UL; 1226 writew(dc->last_ier, dc->reg_ier); 1227 if (send_data(PORT_APP2, dc)) { 1228 writew(APP2_UL, dc->reg_fcr); 1229 dc->last_ier = dc->last_ier | APP2_UL; 1230 writew(dc->last_ier, dc->reg_ier); 1231 } 1232 } 1233 1234 exit_handler: 1235 spin_unlock(&dc->spin_mutex); 1236 1237 for (a = 0; a < NOZOMI_MAX_PORTS; a++) 1238 if (test_and_clear_bit(a, &dc->flip)) 1239 tty_flip_buffer_push(&dc->port[a].port); 1240 1241 return IRQ_HANDLED; 1242 none: 1243 spin_unlock(&dc->spin_mutex); 1244 return IRQ_NONE; 1245 } 1246 1247 static void nozomi_get_card_type(struct nozomi *dc) 1248 { 1249 int i; 1250 u32 size = 0; 1251 1252 for (i = 0; i < 6; i++) 1253 size += pci_resource_len(dc->pdev, i); 1254 1255 /* Assume card type F32_8 if no match */ 1256 dc->card_type = size == 2048 ? F32_2 : F32_8; 1257 1258 dev_info(&dc->pdev->dev, "Card type is: %d\n", dc->card_type); 1259 } 1260 1261 static void nozomi_setup_private_data(struct nozomi *dc) 1262 { 1263 void __iomem *offset = dc->base_addr + dc->card_type / 2; 1264 unsigned int i; 1265 1266 dc->reg_fcr = (void __iomem *)(offset + R_FCR); 1267 dc->reg_iir = (void __iomem *)(offset + R_IIR); 1268 dc->reg_ier = (void __iomem *)(offset + R_IER); 1269 dc->last_ier = 0; 1270 dc->flip = 0; 1271 1272 dc->port[PORT_MDM].token_dl = MDM_DL; 1273 dc->port[PORT_DIAG].token_dl = DIAG_DL; 1274 dc->port[PORT_APP1].token_dl = APP1_DL; 1275 dc->port[PORT_APP2].token_dl = APP2_DL; 1276 1277 for (i = 0; i < MAX_PORT; i++) 1278 init_waitqueue_head(&dc->port[i].tty_wait); 1279 } 1280 1281 static ssize_t card_type_show(struct device *dev, struct device_attribute *attr, 1282 char *buf) 1283 { 1284 const struct nozomi *dc = dev_get_drvdata(dev); 1285 1286 return sprintf(buf, "%d\n", dc->card_type); 1287 } 1288 static DEVICE_ATTR_RO(card_type); 1289 1290 static ssize_t open_ttys_show(struct device *dev, struct device_attribute *attr, 1291 char *buf) 1292 { 1293 const struct nozomi *dc = dev_get_drvdata(dev); 1294 1295 return sprintf(buf, "%u\n", dc->open_ttys); 1296 } 1297 static DEVICE_ATTR_RO(open_ttys); 1298 1299 static void make_sysfs_files(struct nozomi *dc) 1300 { 1301 if (device_create_file(&dc->pdev->dev, &dev_attr_card_type)) 1302 dev_err(&dc->pdev->dev, 1303 "Could not create sysfs file for card_type\n"); 1304 if (device_create_file(&dc->pdev->dev, &dev_attr_open_ttys)) 1305 dev_err(&dc->pdev->dev, 1306 "Could not create sysfs file for open_ttys\n"); 1307 } 1308 1309 static void remove_sysfs_files(struct nozomi *dc) 1310 { 1311 device_remove_file(&dc->pdev->dev, &dev_attr_card_type); 1312 device_remove_file(&dc->pdev->dev, &dev_attr_open_ttys); 1313 } 1314 1315 /* Allocate memory for one device */ 1316 static int nozomi_card_init(struct pci_dev *pdev, 1317 const struct pci_device_id *ent) 1318 { 1319 int ret; 1320 struct nozomi *dc = NULL; 1321 int ndev_idx; 1322 int i; 1323 1324 dev_dbg(&pdev->dev, "Init, new card found\n"); 1325 1326 for (ndev_idx = 0; ndev_idx < ARRAY_SIZE(ndevs); ndev_idx++) 1327 if (!ndevs[ndev_idx]) 1328 break; 1329 1330 if (ndev_idx >= ARRAY_SIZE(ndevs)) { 1331 dev_err(&pdev->dev, "no free tty range for this card left\n"); 1332 ret = -EIO; 1333 goto err; 1334 } 1335 1336 dc = kzalloc(sizeof(struct nozomi), GFP_KERNEL); 1337 if (unlikely(!dc)) { 1338 dev_err(&pdev->dev, "Could not allocate memory\n"); 1339 ret = -ENOMEM; 1340 goto err_free; 1341 } 1342 1343 dc->pdev = pdev; 1344 1345 ret = pci_enable_device(dc->pdev); 1346 if (ret) { 1347 dev_err(&pdev->dev, "Failed to enable PCI Device\n"); 1348 goto err_free; 1349 } 1350 1351 ret = pci_request_regions(dc->pdev, NOZOMI_NAME); 1352 if (ret) { 1353 dev_err(&pdev->dev, "I/O address 0x%04x already in use\n", 1354 (int) /* nozomi_private.io_addr */ 0); 1355 goto err_disable_device; 1356 } 1357 1358 /* Find out what card type it is */ 1359 nozomi_get_card_type(dc); 1360 1361 dc->base_addr = pci_iomap(dc->pdev, 0, dc->card_type); 1362 if (!dc->base_addr) { 1363 dev_err(&pdev->dev, "Unable to map card MMIO\n"); 1364 ret = -ENODEV; 1365 goto err_rel_regs; 1366 } 1367 1368 dc->send_buf = kmalloc(SEND_BUF_MAX, GFP_KERNEL); 1369 if (!dc->send_buf) { 1370 dev_err(&pdev->dev, "Could not allocate send buffer?\n"); 1371 ret = -ENOMEM; 1372 goto err_free_sbuf; 1373 } 1374 1375 for (i = PORT_MDM; i < MAX_PORT; i++) { 1376 if (kfifo_alloc(&dc->port[i].fifo_ul, FIFO_BUFFER_SIZE_UL, 1377 GFP_KERNEL)) { 1378 dev_err(&pdev->dev, 1379 "Could not allocate kfifo buffer\n"); 1380 ret = -ENOMEM; 1381 goto err_free_kfifo; 1382 } 1383 } 1384 1385 spin_lock_init(&dc->spin_mutex); 1386 1387 nozomi_setup_private_data(dc); 1388 1389 /* Disable all interrupts */ 1390 dc->last_ier = 0; 1391 writew(dc->last_ier, dc->reg_ier); 1392 1393 ret = request_irq(pdev->irq, &interrupt_handler, IRQF_SHARED, 1394 NOZOMI_NAME, dc); 1395 if (unlikely(ret)) { 1396 dev_err(&pdev->dev, "can't request irq %d\n", pdev->irq); 1397 goto err_free_kfifo; 1398 } 1399 1400 DBG1("base_addr: %p", dc->base_addr); 1401 1402 make_sysfs_files(dc); 1403 1404 dc->index_start = ndev_idx * MAX_PORT; 1405 ndevs[ndev_idx] = dc; 1406 1407 pci_set_drvdata(pdev, dc); 1408 1409 /* Enable RESET interrupt */ 1410 dc->last_ier = RESET; 1411 iowrite16(dc->last_ier, dc->reg_ier); 1412 1413 dc->state = NOZOMI_STATE_ENABLED; 1414 1415 for (i = 0; i < MAX_PORT; i++) { 1416 struct device *tty_dev; 1417 struct port *port = &dc->port[i]; 1418 port->dc = dc; 1419 tty_port_init(&port->port); 1420 port->port.ops = &noz_tty_port_ops; 1421 tty_dev = tty_port_register_device(&port->port, ntty_driver, 1422 dc->index_start + i, &pdev->dev); 1423 1424 if (IS_ERR(tty_dev)) { 1425 ret = PTR_ERR(tty_dev); 1426 dev_err(&pdev->dev, "Could not allocate tty?\n"); 1427 tty_port_destroy(&port->port); 1428 goto err_free_tty; 1429 } 1430 } 1431 1432 return 0; 1433 1434 err_free_tty: 1435 for (i = 0; i < MAX_PORT; ++i) { 1436 tty_unregister_device(ntty_driver, dc->index_start + i); 1437 tty_port_destroy(&dc->port[i].port); 1438 } 1439 err_free_kfifo: 1440 for (i = 0; i < MAX_PORT; i++) 1441 kfifo_free(&dc->port[i].fifo_ul); 1442 err_free_sbuf: 1443 kfree(dc->send_buf); 1444 iounmap(dc->base_addr); 1445 err_rel_regs: 1446 pci_release_regions(pdev); 1447 err_disable_device: 1448 pci_disable_device(pdev); 1449 err_free: 1450 kfree(dc); 1451 err: 1452 return ret; 1453 } 1454 1455 static void tty_exit(struct nozomi *dc) 1456 { 1457 unsigned int i; 1458 1459 DBG1(" "); 1460 1461 for (i = 0; i < MAX_PORT; ++i) 1462 tty_port_tty_hangup(&dc->port[i].port, false); 1463 1464 /* Racy below - surely should wait for scheduled work to be done or 1465 complete off a hangup method ? */ 1466 while (dc->open_ttys) 1467 msleep(1); 1468 for (i = 0; i < MAX_PORT; ++i) { 1469 tty_unregister_device(ntty_driver, dc->index_start + i); 1470 tty_port_destroy(&dc->port[i].port); 1471 } 1472 } 1473 1474 /* Deallocate memory for one device */ 1475 static void nozomi_card_exit(struct pci_dev *pdev) 1476 { 1477 int i; 1478 struct ctrl_ul ctrl; 1479 struct nozomi *dc = pci_get_drvdata(pdev); 1480 1481 /* Disable all interrupts */ 1482 dc->last_ier = 0; 1483 writew(dc->last_ier, dc->reg_ier); 1484 1485 tty_exit(dc); 1486 1487 /* Send 0x0001, command card to resend the reset token. */ 1488 /* This is to get the reset when the module is reloaded. */ 1489 ctrl.port = 0x00; 1490 ctrl.reserved = 0; 1491 ctrl.RTS = 0; 1492 ctrl.DTR = 1; 1493 DBG1("sending flow control 0x%04X", *((u16 *)&ctrl)); 1494 1495 /* Setup dc->reg addresses to we can use defines here */ 1496 write_mem32(dc->port[PORT_CTRL].ul_addr[0], (u32 *)&ctrl, 2); 1497 writew(CTRL_UL, dc->reg_fcr); /* push the token to the card. */ 1498 1499 remove_sysfs_files(dc); 1500 1501 free_irq(pdev->irq, dc); 1502 1503 for (i = 0; i < MAX_PORT; i++) 1504 kfifo_free(&dc->port[i].fifo_ul); 1505 1506 kfree(dc->send_buf); 1507 1508 iounmap(dc->base_addr); 1509 1510 pci_release_regions(pdev); 1511 1512 pci_disable_device(pdev); 1513 1514 ndevs[dc->index_start / MAX_PORT] = NULL; 1515 1516 kfree(dc); 1517 } 1518 1519 static void set_rts(const struct tty_struct *tty, int rts) 1520 { 1521 struct port *port = get_port_by_tty(tty); 1522 1523 port->ctrl_ul.RTS = rts; 1524 port->update_flow_control = 1; 1525 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty)); 1526 } 1527 1528 static void set_dtr(const struct tty_struct *tty, int dtr) 1529 { 1530 struct port *port = get_port_by_tty(tty); 1531 1532 DBG1("SETTING DTR index: %d, dtr: %d", tty->index, dtr); 1533 1534 port->ctrl_ul.DTR = dtr; 1535 port->update_flow_control = 1; 1536 enable_transmit_ul(PORT_CTRL, get_dc_by_tty(tty)); 1537 } 1538 1539 /* 1540 * ---------------------------------------------------------------------------- 1541 * TTY code 1542 * ---------------------------------------------------------------------------- 1543 */ 1544 1545 static int ntty_install(struct tty_driver *driver, struct tty_struct *tty) 1546 { 1547 struct port *port = get_port_by_tty(tty); 1548 struct nozomi *dc = get_dc_by_tty(tty); 1549 int ret; 1550 if (!port || !dc || dc->state != NOZOMI_STATE_READY) 1551 return -ENODEV; 1552 ret = tty_standard_install(driver, tty); 1553 if (ret == 0) 1554 tty->driver_data = port; 1555 return ret; 1556 } 1557 1558 static void ntty_cleanup(struct tty_struct *tty) 1559 { 1560 tty->driver_data = NULL; 1561 } 1562 1563 static int ntty_activate(struct tty_port *tport, struct tty_struct *tty) 1564 { 1565 struct port *port = container_of(tport, struct port, port); 1566 struct nozomi *dc = port->dc; 1567 unsigned long flags; 1568 1569 DBG1("open: %d", port->token_dl); 1570 spin_lock_irqsave(&dc->spin_mutex, flags); 1571 dc->last_ier = dc->last_ier | port->token_dl; 1572 writew(dc->last_ier, dc->reg_ier); 1573 dc->open_ttys++; 1574 spin_unlock_irqrestore(&dc->spin_mutex, flags); 1575 printk("noz: activated %d: %p\n", tty->index, tport); 1576 return 0; 1577 } 1578 1579 static int ntty_open(struct tty_struct *tty, struct file *filp) 1580 { 1581 struct port *port = tty->driver_data; 1582 return tty_port_open(&port->port, tty, filp); 1583 } 1584 1585 static void ntty_shutdown(struct tty_port *tport) 1586 { 1587 struct port *port = container_of(tport, struct port, port); 1588 struct nozomi *dc = port->dc; 1589 unsigned long flags; 1590 1591 DBG1("close: %d", port->token_dl); 1592 spin_lock_irqsave(&dc->spin_mutex, flags); 1593 dc->last_ier &= ~(port->token_dl); 1594 writew(dc->last_ier, dc->reg_ier); 1595 dc->open_ttys--; 1596 spin_unlock_irqrestore(&dc->spin_mutex, flags); 1597 printk("noz: shutdown %p\n", tport); 1598 } 1599 1600 static void ntty_close(struct tty_struct *tty, struct file *filp) 1601 { 1602 struct port *port = tty->driver_data; 1603 if (port) 1604 tty_port_close(&port->port, tty, filp); 1605 } 1606 1607 static void ntty_hangup(struct tty_struct *tty) 1608 { 1609 struct port *port = tty->driver_data; 1610 tty_port_hangup(&port->port); 1611 } 1612 1613 /* 1614 * called when the userspace process writes to the tty (/dev/noz*). 1615 * Data is inserted into a fifo, which is then read and transferred to the modem. 1616 */ 1617 static int ntty_write(struct tty_struct *tty, const unsigned char *buffer, 1618 int count) 1619 { 1620 int rval = -EINVAL; 1621 struct nozomi *dc = get_dc_by_tty(tty); 1622 struct port *port = tty->driver_data; 1623 unsigned long flags; 1624 1625 /* DBG1( "WRITEx: %d, index = %d", count, index); */ 1626 1627 if (!dc || !port) 1628 return -ENODEV; 1629 1630 rval = kfifo_in(&port->fifo_ul, (unsigned char *)buffer, count); 1631 1632 spin_lock_irqsave(&dc->spin_mutex, flags); 1633 /* CTS is only valid on the modem channel */ 1634 if (port == &(dc->port[PORT_MDM])) { 1635 if (port->ctrl_dl.CTS) { 1636 DBG4("Enable interrupt"); 1637 enable_transmit_ul(tty->index % MAX_PORT, dc); 1638 } else { 1639 dev_err(&dc->pdev->dev, 1640 "CTS not active on modem port?\n"); 1641 } 1642 } else { 1643 enable_transmit_ul(tty->index % MAX_PORT, dc); 1644 } 1645 spin_unlock_irqrestore(&dc->spin_mutex, flags); 1646 1647 return rval; 1648 } 1649 1650 /* 1651 * Calculate how much is left in device 1652 * This method is called by the upper tty layer. 1653 * #according to sources N_TTY.c it expects a value >= 0 and 1654 * does not check for negative values. 1655 * 1656 * If the port is unplugged report lots of room and let the bits 1657 * dribble away so we don't block anything. 1658 */ 1659 static int ntty_write_room(struct tty_struct *tty) 1660 { 1661 struct port *port = tty->driver_data; 1662 int room = 4096; 1663 const struct nozomi *dc = get_dc_by_tty(tty); 1664 1665 if (dc) 1666 room = kfifo_avail(&port->fifo_ul); 1667 1668 return room; 1669 } 1670 1671 /* Gets io control parameters */ 1672 static int ntty_tiocmget(struct tty_struct *tty) 1673 { 1674 const struct port *port = tty->driver_data; 1675 const struct ctrl_dl *ctrl_dl = &port->ctrl_dl; 1676 const struct ctrl_ul *ctrl_ul = &port->ctrl_ul; 1677 1678 /* Note: these could change under us but it is not clear this 1679 matters if so */ 1680 return (ctrl_ul->RTS ? TIOCM_RTS : 0) 1681 | (ctrl_ul->DTR ? TIOCM_DTR : 0) 1682 | (ctrl_dl->DCD ? TIOCM_CAR : 0) 1683 | (ctrl_dl->RI ? TIOCM_RNG : 0) 1684 | (ctrl_dl->DSR ? TIOCM_DSR : 0) 1685 | (ctrl_dl->CTS ? TIOCM_CTS : 0); 1686 } 1687 1688 /* Sets io controls parameters */ 1689 static int ntty_tiocmset(struct tty_struct *tty, 1690 unsigned int set, unsigned int clear) 1691 { 1692 struct nozomi *dc = get_dc_by_tty(tty); 1693 unsigned long flags; 1694 1695 spin_lock_irqsave(&dc->spin_mutex, flags); 1696 if (set & TIOCM_RTS) 1697 set_rts(tty, 1); 1698 else if (clear & TIOCM_RTS) 1699 set_rts(tty, 0); 1700 1701 if (set & TIOCM_DTR) 1702 set_dtr(tty, 1); 1703 else if (clear & TIOCM_DTR) 1704 set_dtr(tty, 0); 1705 spin_unlock_irqrestore(&dc->spin_mutex, flags); 1706 1707 return 0; 1708 } 1709 1710 static int ntty_cflags_changed(struct port *port, unsigned long flags, 1711 struct async_icount *cprev) 1712 { 1713 const struct async_icount cnow = port->tty_icount; 1714 int ret; 1715 1716 ret = ((flags & TIOCM_RNG) && (cnow.rng != cprev->rng)) 1717 || ((flags & TIOCM_DSR) && (cnow.dsr != cprev->dsr)) 1718 || ((flags & TIOCM_CD) && (cnow.dcd != cprev->dcd)) 1719 || ((flags & TIOCM_CTS) && (cnow.cts != cprev->cts)); 1720 1721 *cprev = cnow; 1722 1723 return ret; 1724 } 1725 1726 static int ntty_tiocgicount(struct tty_struct *tty, 1727 struct serial_icounter_struct *icount) 1728 { 1729 struct port *port = tty->driver_data; 1730 const struct async_icount cnow = port->tty_icount; 1731 1732 icount->cts = cnow.cts; 1733 icount->dsr = cnow.dsr; 1734 icount->rng = cnow.rng; 1735 icount->dcd = cnow.dcd; 1736 icount->rx = cnow.rx; 1737 icount->tx = cnow.tx; 1738 icount->frame = cnow.frame; 1739 icount->overrun = cnow.overrun; 1740 icount->parity = cnow.parity; 1741 icount->brk = cnow.brk; 1742 icount->buf_overrun = cnow.buf_overrun; 1743 return 0; 1744 } 1745 1746 static int ntty_ioctl(struct tty_struct *tty, 1747 unsigned int cmd, unsigned long arg) 1748 { 1749 struct port *port = tty->driver_data; 1750 int rval = -ENOIOCTLCMD; 1751 1752 DBG1("******** IOCTL, cmd: %d", cmd); 1753 1754 switch (cmd) { 1755 case TIOCMIWAIT: { 1756 struct async_icount cprev = port->tty_icount; 1757 1758 rval = wait_event_interruptible(port->tty_wait, 1759 ntty_cflags_changed(port, arg, &cprev)); 1760 break; 1761 } 1762 default: 1763 DBG1("ERR: 0x%08X, %d", cmd, cmd); 1764 break; 1765 } 1766 1767 return rval; 1768 } 1769 1770 /* 1771 * Called by the upper tty layer when tty buffers are ready 1772 * to receive data again after a call to throttle. 1773 */ 1774 static void ntty_unthrottle(struct tty_struct *tty) 1775 { 1776 struct nozomi *dc = get_dc_by_tty(tty); 1777 unsigned long flags; 1778 1779 DBG1("UNTHROTTLE"); 1780 spin_lock_irqsave(&dc->spin_mutex, flags); 1781 enable_transmit_dl(tty->index % MAX_PORT, dc); 1782 set_rts(tty, 1); 1783 1784 spin_unlock_irqrestore(&dc->spin_mutex, flags); 1785 } 1786 1787 /* 1788 * Called by the upper tty layer when the tty buffers are almost full. 1789 * The driver should stop send more data. 1790 */ 1791 static void ntty_throttle(struct tty_struct *tty) 1792 { 1793 struct nozomi *dc = get_dc_by_tty(tty); 1794 unsigned long flags; 1795 1796 DBG1("THROTTLE"); 1797 spin_lock_irqsave(&dc->spin_mutex, flags); 1798 set_rts(tty, 0); 1799 spin_unlock_irqrestore(&dc->spin_mutex, flags); 1800 } 1801 1802 /* Returns number of chars in buffer, called by tty layer */ 1803 static s32 ntty_chars_in_buffer(struct tty_struct *tty) 1804 { 1805 struct port *port = tty->driver_data; 1806 struct nozomi *dc = get_dc_by_tty(tty); 1807 s32 rval = 0; 1808 1809 if (unlikely(!dc || !port)) { 1810 goto exit_in_buffer; 1811 } 1812 1813 rval = kfifo_len(&port->fifo_ul); 1814 1815 exit_in_buffer: 1816 return rval; 1817 } 1818 1819 static const struct tty_port_operations noz_tty_port_ops = { 1820 .activate = ntty_activate, 1821 .shutdown = ntty_shutdown, 1822 }; 1823 1824 static const struct tty_operations tty_ops = { 1825 .ioctl = ntty_ioctl, 1826 .open = ntty_open, 1827 .close = ntty_close, 1828 .hangup = ntty_hangup, 1829 .write = ntty_write, 1830 .write_room = ntty_write_room, 1831 .unthrottle = ntty_unthrottle, 1832 .throttle = ntty_throttle, 1833 .chars_in_buffer = ntty_chars_in_buffer, 1834 .tiocmget = ntty_tiocmget, 1835 .tiocmset = ntty_tiocmset, 1836 .get_icount = ntty_tiocgicount, 1837 .install = ntty_install, 1838 .cleanup = ntty_cleanup, 1839 }; 1840 1841 /* Module initialization */ 1842 static struct pci_driver nozomi_driver = { 1843 .name = NOZOMI_NAME, 1844 .id_table = nozomi_pci_tbl, 1845 .probe = nozomi_card_init, 1846 .remove = nozomi_card_exit, 1847 }; 1848 1849 static __init int nozomi_init(void) 1850 { 1851 int ret; 1852 1853 printk(KERN_INFO "Initializing %s\n", VERSION_STRING); 1854 1855 ntty_driver = alloc_tty_driver(NTTY_TTY_MAXMINORS); 1856 if (!ntty_driver) 1857 return -ENOMEM; 1858 1859 ntty_driver->driver_name = NOZOMI_NAME_TTY; 1860 ntty_driver->name = "noz"; 1861 ntty_driver->major = 0; 1862 ntty_driver->type = TTY_DRIVER_TYPE_SERIAL; 1863 ntty_driver->subtype = SERIAL_TYPE_NORMAL; 1864 ntty_driver->flags = TTY_DRIVER_REAL_RAW | TTY_DRIVER_DYNAMIC_DEV; 1865 ntty_driver->init_termios = tty_std_termios; 1866 ntty_driver->init_termios.c_cflag = B115200 | CS8 | CREAD | \ 1867 HUPCL | CLOCAL; 1868 ntty_driver->init_termios.c_ispeed = 115200; 1869 ntty_driver->init_termios.c_ospeed = 115200; 1870 tty_set_operations(ntty_driver, &tty_ops); 1871 1872 ret = tty_register_driver(ntty_driver); 1873 if (ret) { 1874 printk(KERN_ERR "Nozomi: failed to register ntty driver\n"); 1875 goto free_tty; 1876 } 1877 1878 ret = pci_register_driver(&nozomi_driver); 1879 if (ret) { 1880 printk(KERN_ERR "Nozomi: can't register pci driver\n"); 1881 goto unr_tty; 1882 } 1883 1884 return 0; 1885 unr_tty: 1886 tty_unregister_driver(ntty_driver); 1887 free_tty: 1888 put_tty_driver(ntty_driver); 1889 return ret; 1890 } 1891 1892 static __exit void nozomi_exit(void) 1893 { 1894 printk(KERN_INFO "Unloading %s\n", DRIVER_DESC); 1895 pci_unregister_driver(&nozomi_driver); 1896 tty_unregister_driver(ntty_driver); 1897 put_tty_driver(ntty_driver); 1898 } 1899 1900 module_init(nozomi_init); 1901 module_exit(nozomi_exit); 1902 1903 MODULE_LICENSE("Dual BSD/GPL"); 1904 MODULE_DESCRIPTION(DRIVER_DESC); 1905