Subversion Repositories Kolibri OS

Rev

Rev 4519 | Rev 4522 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  2. ;;                                                                 ;;
  3. ;; Copyright (C) KolibriOS team 2004-2014. All rights reserved.    ;;
  4. ;; Distributed under terms of the GNU General Public License       ;;
  5. ;;                                                                 ;;
  6. ;;  i8254x driver for KolibriOS                                    ;;
  7. ;;                                                                 ;;
  8. ;;  based on i8254x.asm from baremetal os                          ;;
  9. ;;                                                                 ;;
  10. ;;    Written by hidnplayr (hidnplayr@gmail.com)                   ;;
  11. ;;                                                                 ;;
  12. ;;          GNU GENERAL PUBLIC LICENSE                             ;;
  13. ;;             Version 2, June 1991                                ;;
  14. ;;                                                                 ;;
  15. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  16.  
  17. format MS COFF
  18.  
  19.         API_VERSION             = 0x01000100
  20.         DRIVER_VERSION          = 5
  21.  
  22.         MAX_DEVICES             = 16
  23.  
  24.         DEBUG                   = 1
  25.         __DEBUG__               = 1
  26.         __DEBUG_LEVEL__         = 2             ; 1 = verbose, 2 = errors only
  27.  
  28.         MAX_PKT_SIZE            = 4096          ; Maximum packet size
  29.  
  30.         RX_RING_SIZE            = 8             ; Must be a power of 2, and minimum 8
  31.         TX_RING_SIZE            = 8             ; Must be a power of 2, and minimum 8
  32.  
  33. include '../struct.inc'
  34. include '../macros.inc'
  35. include '../proc32.inc'
  36. include '../imports.inc'
  37. include '../fdo.inc'
  38. include '../netdrv.inc'
  39.  
  40. public START
  41. public service_proc
  42. public version
  43.  
  44.  
  45.  
  46. ; Register list
  47. REG_CTRL                = 0x0000 ; Control Register
  48. REG_STATUS              = 0x0008 ; Device Status Register
  49. REG_CTRLEXT             = 0x0018 ; Extended Control Register
  50. REG_MDIC                = 0x0020 ; MDI Control Register
  51. REG_FCAL                = 0x0028 ; Flow Control Address Low
  52. REG_FCAH                = 0x002C ; Flow Control Address High
  53. REG_FCT                 = 0x0030 ; Flow Control Type
  54. REG_VET                 = 0x0038 ; VLAN Ether Type
  55. REG_ICR                 = 0x00C0 ; Interrupt Cause Read
  56. REG_ITR                 = 0x00C4 ; Interrupt Throttling Register
  57. REG_ICS                 = 0x00C8 ; Interrupt Cause Set Register
  58. REG_IMS                 = 0x00D0 ; Interrupt Mask Set/Read Register
  59. REG_IMC                 = 0x00D8 ; Interrupt Mask Clear Register
  60. REG_RCTL                = 0x0100 ; Receive Control Register
  61. REG_FCTTV               = 0x0170 ; Flow Control Transmit Timer Value
  62. REG_TXCW                = 0x0178 ; Transmit Configuration Word
  63. REG_RXCW                = 0x0180 ; Receive Configuration Word
  64. REG_TCTL                = 0x0400 ; Transmit Control Register
  65. REG_TIPG                = 0x0410 ; Transmit Inter Packet Gap
  66.  
  67. REG_LEDCTL              = 0x0E00 ; LED Control
  68. REG_PBA                 = 0x1000 ; Packet Buffer Allocation
  69.  
  70. REG_RDBAL               = 0x2800 ; RX Descriptor Base Address Low
  71. REG_RDBAH               = 0x2804 ; RX Descriptor Base Address High
  72. REG_RDLEN               = 0x2808 ; RX Descriptor Length
  73. REG_RDH                 = 0x2810 ; RX Descriptor Head
  74. REG_RDT                 = 0x2818 ; RX Descriptor Tail
  75. REG_RDTR                = 0x2820 ; RX Delay Timer Register
  76. REG_RXDCTL              = 0x3828 ; RX Descriptor Control
  77. REG_RADV                = 0x282C ; RX Int. Absolute Delay Timer
  78. REG_RSRPD               = 0x2C00 ; RX Small Packet Detect Interrupt
  79.  
  80. REG_TXDMAC              = 0x3000 ; TX DMA Control
  81. REG_TDBAL               = 0x3800 ; TX Descriptor Base Address Low
  82. REG_TDBAH               = 0x3804 ; TX Descriptor Base Address High
  83. REG_TDLEN               = 0x3808 ; TX Descriptor Length
  84. REG_TDH                 = 0x3810 ; TX Descriptor Head
  85. REG_TDT                 = 0x3818 ; TX Descriptor Tail
  86. REG_TIDV                = 0x3820 ; TX Interrupt Delay Value
  87. REG_TXDCTL              = 0x3828 ; TX Descriptor Control
  88. REG_TADV                = 0x382C ; TX Absolute Interrupt Delay Value
  89. REG_TSPMT               = 0x3830 ; TCP Segmentation Pad & Min Threshold
  90.  
  91. REG_RXCSUM              = 0x5000 ; RX Checksum Control
  92.  
  93. ; Register list for i8254x
  94. I82542_REG_RDTR         = 0x0108 ; RX Delay Timer Register
  95. I82542_REG_RDBAL        = 0x0110 ; RX Descriptor Base Address Low
  96. I82542_REG_RDBAH        = 0x0114 ; RX Descriptor Base Address High
  97. I82542_REG_RDLEN        = 0x0118 ; RX Descriptor Length
  98. I82542_REG_RDH          = 0x0120 ; RDH for i82542
  99. I82542_REG_RDT          = 0x0128 ; RDT for i82542
  100. I82542_REG_TDBAL        = 0x0420 ; TX Descriptor Base Address Low
  101. I82542_REG_TDBAH        = 0x0424 ; TX Descriptor Base Address Low
  102. I82542_REG_TDLEN        = 0x0428 ; TX Descriptor Length
  103. I82542_REG_TDH          = 0x0430 ; TDH for i82542
  104. I82542_REG_TDT          = 0x0438 ; TDT for i82542
  105.  
  106. ; CTRL - Control Register (0x0000)
  107. CTRL_FD                 = 0x00000001 ; Full Duplex
  108. CTRL_LRST               = 0x00000008 ; Link Reset
  109. CTRL_ASDE               = 0x00000020 ; Auto-speed detection
  110. CTRL_SLU                = 0x00000040 ; Set Link Up
  111. CTRL_ILOS               = 0x00000080 ; Invert Loss of Signal
  112. CTRL_SPEED_MASK         = 0x00000300 ; Speed selection
  113. CTRL_SPEED_SHIFT        = 8
  114. CTRL_FRCSPD             = 0x00000800 ; Force Speed
  115. CTRL_FRCDPLX            = 0x00001000 ; Force Duplex
  116. CTRL_SDP0_DATA          = 0x00040000 ; SDP0 data
  117. CTRL_SDP1_DATA          = 0x00080000 ; SDP1 data
  118. CTRL_SDP0_IODIR         = 0x00400000 ; SDP0 direction
  119. CTRL_SDP1_IODIR         = 0x00800000 ; SDP1 direction
  120. CTRL_RST                = 0x04000000 ; Device Reset
  121. CTRL_RFCE               = 0x08000000 ; RX Flow Ctrl Enable
  122. CTRL_TFCE               = 0x10000000 ; TX Flow Ctrl Enable
  123. CTRL_VME                = 0x40000000 ; VLAN Mode Enable
  124. CTRL_PHY_RST            = 0x80000000 ; PHY reset
  125.  
  126. ; STATUS - Device Status Register (0x0008)
  127. STATUS_FD               = 0x00000001 ; Full Duplex
  128. STATUS_LU               = 0x00000002 ; Link Up
  129. STATUS_TXOFF            = 0x00000010 ; Transmit paused
  130. STATUS_TBIMODE          = 0x00000020 ; TBI Mode
  131. STATUS_SPEED_MASK       = 0x000000C0 ; Link Speed setting
  132. STATUS_SPEED_SHIFT      = 6
  133. STATUS_ASDV_MASK        = 0x00000300 ; Auto Speed Detection
  134. STATUS_ASDV_SHIFT       = 8
  135. STATUS_PCI66            = 0x00000800 ; PCI bus speed
  136. STATUS_BUS64            = 0x00001000 ; PCI bus width
  137. STATUS_PCIX_MODE        = 0x00002000 ; PCI-X mode
  138. STATUS_PCIXSPD_MASK     = 0x0000C000 ; PCI-X speed
  139. STATUS_PCIXSPD_SHIFT    = 14
  140.  
  141. ; CTRL_EXT - Extended Device Control Register (0x0018)
  142. CTRLEXT_PHY_INT         = 0x00000020 ; PHY interrupt
  143. CTRLEXT_SDP6_DATA       = 0x00000040 ; SDP6 data
  144. CTRLEXT_SDP7_DATA       = 0x00000080 ; SDP7 data
  145. CTRLEXT_SDP6_IODIR      = 0x00000400 ; SDP6 direction
  146. CTRLEXT_SDP7_IODIR      = 0x00000800 ; SDP7 direction
  147. CTRLEXT_ASDCHK          = 0x00001000 ; Auto-Speed Detect Chk
  148. CTRLEXT_EE_RST          = 0x00002000 ; EEPROM reset
  149. CTRLEXT_SPD_BYPS        = 0x00008000 ; Speed Select Bypass
  150. CTRLEXT_RO_DIS          = 0x00020000 ; Relaxed Ordering Dis.
  151. CTRLEXT_LNKMOD_MASK     = 0x00C00000 ; Link Mode
  152. CTRLEXT_LNKMOD_SHIFT    = 22
  153.  
  154. ; MDIC - MDI Control Register (0x0020)
  155. MDIC_DATA_MASK          = 0x0000FFFF ; Data
  156. MDIC_REG_MASK           = 0x001F0000 ; PHY Register
  157. MDIC_REG_SHIFT          = 16
  158. MDIC_PHY_MASK           = 0x03E00000 ; PHY Address
  159. MDIC_PHY_SHIFT          = 21
  160. MDIC_OP_MASK            = 0x0C000000 ; Opcode
  161. MDIC_OP_SHIFT           = 26
  162. MDIC_R                  = 0x10000000 ; Ready
  163. MDIC_I                  = 0x20000000 ; Interrupt Enable
  164. MDIC_E                  = 0x40000000 ; Error
  165.  
  166. ; ICR - Interrupt Cause Read (0x00c0)
  167. ICR_TXDW                = 0x00000001 ; TX Desc Written back
  168. ICR_TXQE                = 0x00000002 ; TX Queue Empty
  169. ICR_LSC                 = 0x00000004 ; Link Status Change
  170. ICR_RXSEQ               = 0x00000008 ; RX Sence Error
  171. ICR_RXDMT0              = 0x00000010 ; RX Desc min threshold reached
  172. ICR_RXO                 = 0x00000040 ; RX Overrun
  173. ICR_RXT0                = 0x00000080 ; RX Timer Interrupt
  174. ICR_MDAC                = 0x00000200 ; MDIO Access Complete
  175. ICR_RXCFG               = 0x00000400
  176. ICR_PHY_INT             = 0x00001000 ; PHY Interrupt
  177. ICR_GPI_SDP6            = 0x00002000 ; GPI on SDP6
  178. ICR_GPI_SDP7            = 0x00004000 ; GPI on SDP7
  179. ICR_TXD_LOW             = 0x00008000 ; TX Desc low threshold hit
  180. ICR_SRPD                = 0x00010000 ; Small RX packet detected
  181.  
  182. ; RCTL - Receive Control Register (0x0100)
  183. RCTL_EN                 = 0x00000002 ; Receiver Enable
  184. RCTL_SBP                = 0x00000004 ; Store Bad Packets
  185. RCTL_UPE                = 0x00000008 ; Unicast Promiscuous Enabled
  186. RCTL_MPE                = 0x00000010 ; Xcast Promiscuous Enabled
  187. RCTL_LPE                = 0x00000020 ; Long Packet Reception Enable
  188. RCTL_LBM_MASK           = 0x000000C0 ; Loopback Mode
  189. RCTL_LBM_SHIFT          = 6
  190. RCTL_RDMTS_MASK         = 0x00000300 ; RX Desc Min Threshold Size
  191. RCTL_RDMTS_SHIFT        = 8
  192. RCTL_MO_MASK            = 0x00003000 ; Multicast Offset
  193. RCTL_MO_SHIFT           = 12
  194. RCTL_BAM                = 0x00008000 ; Broadcast Accept Mode
  195. RCTL_BSIZE_MASK         = 0x00030000 ; RX Buffer Size
  196. RCTL_BSIZE_SHIFT        = 16
  197. RCTL_VFE                = 0x00040000 ; VLAN Filter Enable
  198. RCTL_CFIEN              = 0x00080000 ; CFI Enable
  199. RCTL_CFI                = 0x00100000 ; Canonical Form Indicator Bit
  200. RCTL_DPF                = 0x00400000 ; Discard Pause Frames
  201. RCTL_PMCF               = 0x00800000 ; Pass MAC Control Frames
  202. RCTL_BSEX               = 0x02000000 ; Buffer Size Extension
  203. RCTL_SECRC              = 0x04000000 ; Strip Ethernet CRC
  204.  
  205. ; TCTL - Transmit Control Register (0x0400)
  206. TCTL_EN                 = 0x00000002 ; Transmit Enable
  207. TCTL_PSP                = 0x00000008 ; Pad short packets
  208. TCTL_SWXOFF             = 0x00400000 ; Software XOFF Transmission
  209.  
  210. ; PBA - Packet Buffer Allocation (0x1000)
  211. PBA_RXA_MASK            = 0x0000FFFF ; RX Packet Buffer
  212. PBA_RXA_SHIFT           = 0
  213. PBA_TXA_MASK            = 0xFFFF0000 ; TX Packet Buffer
  214. PBA_TXA_SHIFT           = 16
  215.  
  216. ; Flow Control Type
  217. FCT_TYPE_DEFAULT        = 0x8808
  218.  
  219.  
  220.  
  221. ; === TX Descriptor ===
  222.  
  223. struct TDESC
  224.         addr_l          dd ?
  225.         addr_h          dd ?
  226.  
  227.         length_cso_cmd  dd ?    ; 16 bits length + 8 bits cso + 8 bits cmd
  228.         status          dd ?    ; status, checksum start field, special
  229. ends
  230.  
  231. ; TX Packet Length (word 2)
  232. TXDESC_LEN_MASK         = 0x0000ffff
  233.  
  234. ; TX Descriptor CMD field (word 2)
  235. TXDESC_IDE              = 0x80000000 ; Interrupt Delay Enable
  236. TXDESC_VLE              = 0x40000000 ; VLAN Packet Enable
  237. TXDESC_DEXT             = 0x20000000 ; Extension
  238. TXDESC_RPS              = 0x10000000 ; Report Packet Sent
  239. TXDESC_RS               = 0x08000000 ; Report Status
  240. TXDESC_IC               = 0x04000000 ; Insert Checksum
  241. TXDESC_IFCS             = 0x02000000 ; Insert FCS
  242. TXDESC_EOP              = 0x01000000 ; End Of Packet
  243.  
  244. ; TX Descriptor STA field (word 3)
  245. TXDESC_TU               = 0x00000008 ; Transmit Underrun
  246. TXDESC_LC               = 0x00000004 ; Late Collision
  247. TXDESC_EC               = 0x00000002 ; Excess Collisions
  248. TXDESC_DD               = 0x00000001 ; Descriptor Done
  249.  
  250.  
  251.  
  252. ; === RX Descriptor ===
  253.  
  254. struct RDESC
  255.         addr_l          dd ?
  256.         addr_h          dd ?
  257.         status_l        dd ?
  258.         status_h        dd ?
  259. ends
  260.  
  261. ; RX Packet Length (word 2)
  262. RXDESC_LEN_MASK         = 0x0000ffff
  263.  
  264. ; RX Descriptor STA field (word 3)
  265. RXDESC_PIF              = 0x00000080 ; Passed In-exact Filter
  266. RXDESC_IPCS             = 0x00000040 ; IP cksum calculated
  267. RXDESC_TCPCS            = 0x00000020 ; TCP cksum calculated
  268. RXDESC_VP               = 0x00000008 ; Packet is 802.1Q
  269. RXDESC_IXSM             = 0x00000004 ; Ignore cksum indication
  270. RXDESC_EOP              = 0x00000002 ; End Of Packet
  271. RXDESC_DD               = 0x00000001 ; Descriptor Done
  272.  
  273. virtual at ebx
  274.         device:
  275.         ETH_DEVICE
  276.  
  277.         .mmio_addr      dd ?
  278.         .pci_bus        dd ?
  279.         .pci_dev        dd ?
  280.         .irq_line       db ?
  281.  
  282.         .cur_rx         dd ?
  283.         .cur_tx         dd ?
  284.         .last_tx        dd ?
  285.  
  286.                         rb 0x100 - (($ - device) and 0xff)      ; align 256
  287.         .rx_desc        rb RX_RING_SIZE*sizeof.RDESC*2
  288.  
  289.                         rb 0x100 - (($ - device) and 0xff)      ; align 256
  290.         .tx_desc        rb TX_RING_SIZE*sizeof.TDESC*2
  291.  
  292.         sizeof.device_struct = $ - device
  293.  
  294. end virtual
  295.  
  296.  
  297. section '.flat' code readable align 16
  298.  
  299.  
  300. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  301. ;;                        ;;
  302. ;; proc START             ;;
  303. ;;                        ;;
  304. ;; (standard driver proc) ;;
  305. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  306.  
  307. align 4
  308. proc START stdcall, state:dword
  309.  
  310.         cmp [state], 1
  311.         jne .exit
  312.  
  313.   .entry:
  314.  
  315.         DEBUGF  1,"Loading driver\n"
  316.         stdcall RegService, my_service, service_proc
  317.         ret
  318.  
  319.   .fail:
  320.   .exit:
  321.         xor eax, eax
  322.         ret
  323.  
  324. endp
  325.  
  326.  
  327.  
  328.  
  329. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  330. ;;                        ;;
  331. ;; proc SERVICE_PROC      ;;
  332. ;;                        ;;
  333. ;; (standard driver proc) ;;
  334. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  335.  
  336. align 4
  337. proc service_proc stdcall, ioctl:dword
  338.  
  339.         mov     edx, [ioctl]
  340.         mov     eax, [edx + IOCTL.io_code]
  341.  
  342. ;------------------------------------------------------
  343.  
  344.         cmp     eax, 0 ;SRV_GETVERSION
  345.         jne     @F
  346.  
  347.         cmp     [edx + IOCTL.out_size], 4
  348.         jb      .fail
  349.         mov     eax, [edx + IOCTL.output]
  350.         mov     [eax], dword API_VERSION
  351.  
  352.         xor     eax, eax
  353.         ret
  354.  
  355. ;------------------------------------------------------
  356.   @@:
  357.         cmp     eax, 1 ;SRV_HOOK
  358.         jne     .fail
  359.  
  360.         cmp     [edx + IOCTL.inp_size], 3                     ; Data input must be at least 3 bytes
  361.         jb      .fail
  362.  
  363.         mov     eax, [edx + IOCTL.input]
  364.         cmp     byte [eax], 1                           ; 1 means device number and bus number (pci) are given
  365.         jne     .fail                                   ; other types arent supported for this card yet
  366.  
  367. ; check if the device is already listed
  368.  
  369.         mov     esi, device_list
  370.         mov     ecx, [devices]
  371.         test    ecx, ecx
  372.         jz      .firstdevice
  373.  
  374. ;        mov     eax, [edx + IOCTL.input]                      ; get the pci bus and device numbers
  375.         mov     ax, [eax+1]                             ;
  376.   .nextdevice:
  377.         mov     ebx, [esi]
  378.         cmp     al, byte [device.pci_bus]
  379.         jne     .next
  380.         cmp     ah, byte [device.pci_dev]
  381.         je      .find_devicenum                         ; Device is already loaded, let's find it's device number
  382.   .next:
  383.         add     esi, 4
  384.         loop    .nextdevice
  385.  
  386.  
  387. ; This device doesnt have its own eth_device structure yet, lets create one
  388.   .firstdevice:
  389.         cmp     [devices], MAX_DEVICES                  ; First check if the driver can handle one more card
  390.         jae     .fail
  391.  
  392.         allocate_and_clear ebx, sizeof.device_struct, .fail      ; Allocate the buffer for device structure
  393.  
  394. ; Fill in the direct call addresses into the struct
  395.  
  396.         mov     [device.reset], reset
  397.         mov     [device.transmit], transmit
  398.         mov     [device.unload], unload
  399.         mov     [device.name], my_service
  400.  
  401. ; save the pci bus and device numbers
  402.  
  403.         mov     eax, [edx + IOCTL.input]
  404.         movzx   ecx, byte [eax+1]
  405.         mov     [device.pci_bus], ecx
  406.         movzx   ecx, byte [eax+2]
  407.         mov     [device.pci_dev], ecx
  408.  
  409. ; Now, it's time to find the base mmio addres of the PCI device
  410.  
  411.         PCI_find_mmio32
  412.  
  413. ; Create virtual mapping of the physical memory
  414.  
  415.         push    1Bh             ; PG_SW+PG_NOCACHE
  416.         push    10000h          ; size of the map
  417.         push    eax
  418.         call    MapIoMem
  419.         mov     [device.mmio_addr], eax
  420.  
  421. ; We've found the mmio address, find IRQ now
  422.  
  423.         PCI_find_irq
  424.  
  425.         DEBUGF  1,"Hooking into device, dev:%x, bus:%x, irq:%x, addr:%x\n",\
  426.         [device.pci_dev]:1,[device.pci_bus]:1,[device.irq_line]:1,[device.mmio_addr]:8
  427.  
  428. ; Ok, the eth_device structure is ready, let's probe the device
  429.         call    probe                                                   ; this function will output in eax
  430.         test    eax, eax
  431.         jnz     .err                                                    ; If an error occured, exit
  432.  
  433.         mov     eax, [devices]                                          ; Add the device structure to our device list
  434.         mov     [device_list+4*eax], ebx                                ; (IRQ handler uses this list to find device)
  435.         inc     [devices]                                               ;
  436.  
  437.         call    start_i8254x
  438.  
  439.         mov     [device.type], NET_TYPE_ETH
  440.         call    NetRegDev
  441.  
  442.         cmp     eax, -1
  443.         je      .destroy
  444.  
  445.         ret
  446.  
  447. ; If the device was already loaded, find the device number and return it in eax
  448.  
  449.   .find_devicenum:
  450.         DEBUGF  1,"Trying to find device number of already registered device\n"
  451.         call    NetPtrToNum                                             ; This kernel procedure converts a pointer to device struct in ebx
  452.                                                                         ; into a device number in edi
  453.         mov     eax, edi                                                ; Application wants it in eax instead
  454.         DEBUGF  1,"Kernel says: %u\n", eax
  455.         ret
  456.  
  457. ; If an error occured, remove all allocated data and exit (returning -1 in eax)
  458.  
  459.   .destroy:
  460.         ; todo: reset device into virgin state
  461.  
  462.   .err:
  463.         stdcall KernelFree, ebx
  464.  
  465.   .fail:
  466.         or      eax, -1
  467.         ret
  468.  
  469. ;------------------------------------------------------
  470. endp
  471.  
  472.  
  473. ;;/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\;;
  474. ;;                                                                        ;;
  475. ;;        Actual Hardware dependent code starts here                      ;;
  476. ;;                                                                        ;;
  477. ;;/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\/\;;
  478.  
  479.  
  480. align 4
  481. unload:
  482.         ; TODO: (in this particular order)
  483.         ;
  484.         ; - Stop the device
  485.         ; - Detach int handler
  486.         ; - Remove device from local list (device_list)
  487.         ; - call unregister function in kernel
  488.         ; - Remove all allocated structures and buffers the card used
  489.  
  490.         or      eax, -1
  491.  
  492. ret
  493.  
  494.  
  495.  
  496. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  497. ;;
  498. ;;  probe: enables the device (if it really is I8254X)
  499. ;;
  500. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  501. align 4
  502. probe:
  503.  
  504.         DEBUGF  1,"Probe\n"
  505.  
  506.         PCI_make_bus_master
  507.  
  508.         ; TODO: validate the device
  509.  
  510.         call    read_mac
  511.  
  512.         movzx   eax, [device.irq_line]
  513.         DEBUGF  1,"Attaching int handler to irq %x\n", eax:1
  514.         stdcall AttachIntHandler, eax, int_handler, dword 0
  515.         test    eax, eax
  516.         jnz     @f
  517.         DEBUGF  2,"Could not attach int handler!\n"
  518.         or      eax, -1
  519.         ret
  520.   @@:
  521.  
  522.  
  523. reset_dontstart:
  524.         DEBUGF  1,"Reset\n"
  525.  
  526.         mov     esi, [device.mmio_addr]
  527.  
  528.         or      dword[esi + REG_CTRL], CTRL_RST         ; reset device
  529.   .loop:
  530.         push    esi
  531.         xor     esi, esi
  532.         inc     esi
  533.         call    Sleep
  534.         pop     esi
  535.         test    dword[esi + REG_CTRL], CTRL_RST
  536.         jnz     .loop
  537.  
  538.         mov     dword[esi + REG_IMC], 0xffffffff        ; Disable all interrupt causes
  539.         mov     eax, dword [esi + REG_ICR]              ; Clear any pending interrupts
  540.         mov     dword[esi + REG_ITR], 0                 ; Disable interrupt throttling logic
  541.  
  542.         mov     dword[esi + REG_PBA], 0x00000004        ; PBA: set the RX buffer size to 4KB (TX buffer is calculated as 64-RX buffer)
  543.         mov     dword[esi + REG_RDTR], 0                ; RDTR: set no delay
  544.  
  545.         mov     dword[esi + REG_TXCW], 0x08008060       ; TXCW: set ANE, TxConfigWord (Half/Full duplex, Next Page Reqest)
  546.  
  547.         mov     eax, [esi + REG_CTRL]
  548.         or      eax, 1 shl 6 + 1 shl 5
  549.         and     eax, not (1 shl 3 + 1 shl 7 + 1 shl 30 + 1 shl 31)
  550.         mov     dword [esi + REG_CTRL], eax             ; CTRL: clear LRST, set SLU and ASDE, clear RSTPHY, VME, and ILOS
  551.  
  552.         lea     edi, [esi + 0x5200]                     ; MTA: reset
  553.         mov     eax, 0xffffffff
  554.         stosd
  555.         stosd
  556.         stosd
  557.         stosd
  558.  
  559.         call    init_rx
  560.         call    init_tx
  561.  
  562.         xor     eax, eax
  563.         ret
  564.  
  565.  
  566.  
  567. align 4
  568. init_rx:
  569.  
  570.         lea     edi, [device.rx_desc]
  571.         mov     ecx, RX_RING_SIZE
  572.   .loop:
  573.         push    ecx
  574.         push    edi
  575.         stdcall KernelAlloc, MAX_PKT_SIZE
  576.         DEBUGF  1,"RX buffer: 0x%x\n", eax
  577.         pop     edi
  578.         mov     dword[edi + RX_RING_SIZE*sizeof.RDESC], eax
  579.         push    edi
  580.         GetRealAddr
  581.         pop     edi
  582.         mov     [edi + RDESC.addr_l], eax
  583.         mov     [edi + RDESC.addr_h], 0
  584.         mov     [edi + RDESC.status_l], 0
  585.         mov     [edi + RDESC.status_h], 0
  586.         add     edi, sizeof.RDESC
  587.         pop     ecx
  588.         dec     ecx
  589.         jnz     .loop
  590.  
  591.         mov     [device.cur_rx], 0
  592.  
  593.         lea     eax, [device.rx_desc]
  594.         GetRealAddr
  595.         mov     dword[esi + REG_RDBAL], eax                             ; Receive Descriptor Base Address Low
  596.         mov     dword[esi + REG_RDBAH], 0                               ; Receive Descriptor Base Address High
  597.         mov     dword[esi + REG_RDLEN], RX_RING_SIZE*sizeof.RDESC       ; Receive Descriptor Length
  598.         mov     dword[esi + REG_RDH], 0                                 ; Receive Descriptor Head
  599.         mov     dword[esi + REG_RDT], RX_RING_SIZE-1                    ; Receive Descriptor Tail
  600.         mov     dword[esi + REG_RCTL], RCTL_SBP or RCTL_BAM or RCTL_SECRC or RCTL_UPE or RCTL_MPE
  601.         ; Store Bad Packets, Broadcast Accept Mode, Strip Ethernet CRC from incoming packet, Promiscuous mode
  602.  
  603.         ret
  604.  
  605.  
  606.  
  607. align 4
  608. init_tx:
  609.  
  610.         lea     edi, [device.tx_desc]
  611.         mov     ecx, TX_RING_SIZE
  612.   .loop:
  613.         mov     [edi + TDESC.addr_l], eax
  614.         mov     [edi + TDESC.addr_h], 0
  615.         mov     [edi + TDESC.length_cso_cmd], 0
  616.         mov     [edi + TDESC.status], 0
  617.         add     edi, sizeof.TDESC
  618.         dec     ecx
  619.         jnz     .loop
  620.  
  621.         mov     [device.cur_tx], 0
  622.         mov     [device.last_tx], 0
  623.  
  624.         lea     eax, [device.tx_desc]
  625.         GetRealAddr
  626.         mov     dword[esi + REG_TDBAL], eax                             ; Transmit Descriptor Base Address Low
  627.         mov     dword[esi + REG_TDBAH], 0                               ; Transmit Descriptor Base Address High
  628.         mov     dword[esi + REG_TDLEN], RX_RING_SIZE*sizeof.TDESC       ; Transmit Descriptor Length
  629.         mov     dword[esi + REG_TDH], 0                                 ; Transmit Descriptor Head
  630.         mov     dword[esi + REG_TDT], 0                                 ; Transmit Descriptor Tail
  631.         mov     dword[esi + REG_TCTL], 0x010400fa                       ; Enabled, Pad Short Packets, 15 retrys, 64-byte COLD, Re-transmit on Late Collision
  632.         mov     dword[esi + REG_TIPG], 0x0060200A                       ; IPGT 10, IPGR1 8, IPGR2 6
  633.  
  634.         ret
  635.  
  636.  
  637. align 4
  638. reset:
  639.         call    reset_dontstart
  640.  
  641. start_i8254x:
  642.  
  643.         mov     esi, [device.mmio_addr]
  644.         or      dword[esi + REG_RCTL], RCTL_EN          ; Enable the receiver
  645.  
  646.         xor     eax, eax
  647.         mov     [esi + REG_RDTR], eax                   ; Clear the Receive Delay Timer Register
  648.         mov     [esi + REG_RADV], eax                   ; Clear the Receive Interrupt Absolute Delay Timer
  649.         mov     [esi + REG_RSRPD], eax                  ; Clear the Receive Small Packet Detect Interrupt
  650.  
  651.         mov     dword[esi + REG_IMS], 0x1F6DC           ; Enable interrupt types
  652.         mov     eax, [esi + REG_ICR]                    ; Clear pending interrupts
  653.  
  654.         mov     [device.mtu], 1514
  655.         mov     [device.state], ETH_LINK_UNKOWN         ; Set link state to unknown
  656.  
  657.         xor     eax, eax
  658.         ret
  659.  
  660.  
  661.  
  662.  
  663. align 4
  664. read_mac:
  665.  
  666.         DEBUGF  1,"Read MAC\n"
  667.  
  668.         mov     esi, [device.mmio_addr]
  669.  
  670.         mov     eax, [esi+0x5400]                       ; RAL
  671.         test    eax, eax
  672.         jz      .try_eeprom
  673.  
  674.         mov     dword[device.mac], eax
  675.         mov     eax, [esi+0x5404]                       ; RAH
  676.         mov     word[device.mac+4], ax
  677.  
  678.         jmp     .mac_ok
  679.  
  680.   .try_eeprom:
  681.         mov     dword[esi+0x14], 0x00000001
  682.         mov     eax, [esi+0x14]
  683.         shr     eax, 16
  684.         mov     word[device.mac], ax
  685.  
  686.         mov     dword[esi+0x14], 0x00000101
  687.         mov     eax, [esi+0x14]
  688.         shr     eax, 16
  689.         mov     word[device.mac+2], ax
  690.  
  691.         mov     dword[esi+0x14], 0x00000201
  692.         mov     eax, [esi+0x14]
  693.         shr     eax, 16
  694.         mov     word[device.mac+4], ax
  695.  
  696.   .mac_ok:
  697.         DEBUGF  1,"MAC = %x-%x-%x-%x-%x-%x\n",\
  698.         [device.mac+0]:2,[device.mac+1]:2,[device.mac+2]:2,[device.mac+3]:2,[device.mac+4]:2,[device.mac+5]:2
  699.  
  700.         ret
  701.  
  702.  
  703. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  704. ;;                                         ;;
  705. ;; Transmit                                ;;
  706. ;;                                         ;;
  707. ;; In: pointer to device structure in ebx  ;;
  708. ;;                                         ;;
  709. ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
  710.  
  711. proc transmit stdcall bufferptr, buffersize
  712.  
  713.         pushf
  714.         cli
  715.  
  716.         DEBUGF  1,"Transmitting packet, buffer:%x, size:%u\n", [bufferptr], [buffersize]
  717.         mov     eax, [bufferptr]
  718.         DEBUGF  1,"To: %x-%x-%x-%x-%x-%x From: %x-%x-%x-%x-%x-%x Type:%x%x\n",\
  719.         [eax+00]:2,[eax+01]:2,[eax+02]:2,[eax+03]:2,[eax+04]:2,[eax+05]:2,\
  720.         [eax+06]:2,[eax+07]:2,[eax+08]:2,[eax+09]:2,[eax+10]:2,[eax+11]:2,\
  721.         [eax+13]:2,[eax+12]:2
  722.  
  723.         cmp     [buffersize], 1514
  724.         ja      .fail
  725.         cmp     [buffersize], 60
  726.         jb      .fail
  727.  
  728. ; Program the descriptor (use legacy mode)
  729.         mov     edi, [device.cur_tx]
  730.         DEBUGF  1, "Using TX desc: %u\n", edi
  731.         shl     edi, 4                                          ; edi = edi * sizeof.TDESC
  732.         lea     edi, [device.tx_desc + edi]
  733.         mov     dword[edi + TX_RING_SIZE*sizeof.TDESC], eax     ; Store the data location (for driver)
  734.         GetRealAddr
  735.         mov     [edi + TDESC.addr_l], eax                       ; Data location (for hardware)
  736.         mov     [edi + TDESC.addr_h], 0
  737.  
  738.         mov     ecx, [buffersize]
  739.         or      ecx, TXDESC_EOP + TXDESC_IFCS + TXDESC_RS
  740.         mov     [edi + TDESC.length_cso_cmd], ecx
  741.         mov     [edi + TDESC.status], 0
  742.  
  743. ; Tell i8254x wich descriptor(s) we programmed
  744.         mov     edi, [device.mmio_addr]
  745.         mov     eax, [device.cur_tx]
  746.         inc     eax
  747.         and     eax, TX_RING_SIZE-1
  748.         mov     [device.cur_tx], eax
  749.         mov     dword[edi + REG_TDT], eax                        ; TDT - Transmit Descriptor Tail
  750.  
  751. ; Update stats
  752.         inc     [device.packets_tx]
  753.         mov     eax, [buffersize]
  754.         add     dword[device.bytes_tx], eax
  755.         adc     dword[device.bytes_tx + 4], 0
  756.  
  757.         popf
  758.         xor     eax, eax
  759.         ret
  760.  
  761.   .fail:
  762.         DEBUGF  2,"Send failed\n"
  763.         stdcall KernelFree, [bufferptr]
  764.         popf
  765.         or      eax, -1
  766.         ret
  767.  
  768. endp
  769.  
  770.  
  771. ;;;;;;;;;;;;;;;;;;;;;;;
  772. ;;                   ;;
  773. ;; Interrupt handler ;;
  774. ;;                   ;;
  775. ;;;;;;;;;;;;;;;;;;;;;;;
  776.  
  777. align 4
  778. int_handler:
  779.  
  780.         push    ebx esi edi
  781.  
  782.         DEBUGF  1,"INT\n"
  783. ;-------------------------------------------
  784. ; Find pointer of device wich made IRQ occur
  785.  
  786.         mov     ecx, [devices]
  787.         test    ecx, ecx
  788.         jz      .nothing
  789.         mov     esi, device_list
  790.   .nextdevice:
  791.         mov     ebx, [esi]
  792.  
  793.         mov     edi, [device.mmio_addr]
  794.         mov     eax, [edi + REG_ICR]
  795.         test    eax, eax
  796.         jnz     .got_it
  797.   .continue:
  798.         add     esi, 4
  799.         dec     ecx
  800.         jnz     .nextdevice
  801.   .nothing:
  802.         pop     edi esi ebx
  803.         xor     eax, eax
  804.  
  805.         ret
  806.  
  807.   .got_it:
  808.  
  809.         DEBUGF  1,"Device: %x Status: %x\n", ebx, eax
  810.  
  811. ;---------
  812. ; RX done?
  813.  
  814.         test    eax, ICR_RXDMT0 + ICR_RXT0
  815.         jz      .no_rx
  816.  
  817.         push    eax ebx
  818.   .retaddr:
  819.         pop     ebx eax
  820. ; Get last descriptor addr
  821.         mov     esi, [device.cur_rx]
  822.         shl     esi, 4                                  ; esi = esi * sizeof.RDESC
  823.         lea     esi, [device.rx_desc + esi]
  824.         cmp     byte[esi + RDESC.status_h], 0           ; Check status field
  825.         je      .no_rx
  826.  
  827.         push    eax ebx
  828.         push    .retaddr
  829.         movzx   ecx, word[esi + 8]                      ; Get the packet length
  830.         DEBUGF  1,"got %u bytes\n", ecx
  831.         push    ecx
  832.         push    dword[esi + RX_RING_SIZE*sizeof.RDESC]  ; Get packet pointer
  833.  
  834. ; Update stats
  835.         add     dword[device.bytes_rx], ecx
  836.         adc     dword[device.bytes_rx + 4], 0
  837.         inc     [device.packets_rx]
  838.  
  839. ; Allocate new descriptor
  840.         push    esi
  841.         stdcall KernelAlloc, MAX_PKT_SIZE
  842.         pop     esi
  843.         mov     dword[esi + RX_RING_SIZE*sizeof.RDESC], eax
  844.         GetRealAddr
  845.         mov     [esi + RDESC.addr_l], eax
  846.         mov     [esi + RDESC.status_l], 0
  847.         mov     [esi + RDESC.status_h], 0
  848.  
  849. ; Move the receive descriptor tail
  850.         mov     esi, [device.mmio_addr]
  851.         mov     eax, [device.cur_rx]
  852.         mov     [esi + REG_RDT], eax
  853.  
  854. ; Move to next rx desc
  855.         inc     [device.cur_rx]
  856.         and     [device.cur_rx], RX_RING_SIZE-1
  857.  
  858.         jmp     Eth_input
  859.   .no_rx:
  860.  
  861. ;--------------
  862. ; Link Changed?
  863.  
  864.         test    eax, ICR_LSC
  865.         jz      .no_link
  866.  
  867.         DEBUGF  2,"Link Changed\n"
  868.  
  869.   .no_link:
  870.  
  871. ;---------------
  872. ; Transmit done?
  873.  
  874.         test    eax, ICR_TXDW
  875.         jz      .no_tx
  876.  
  877.         DEBUGF  1,"Transmit done\n"
  878.  
  879.   .txdesc_loop:
  880.         mov     edi, [device.last_tx]
  881.         shl     edi, 4                                  ; edi = edi * sizeof.TDESC
  882.         lea     edi, [device.tx_desc + edi]
  883.         test    [edi + TDESC.status], TXDESC_DD         ; Descriptor done?
  884.         jz      .no_tx
  885.         cmp     dword[edi + TX_RING_SIZE*sizeof.TDESC], 0
  886.         je      .no_tx
  887.  
  888.         DEBUGF  1,"Cleaning up TX desc: 0x%x\n", edi
  889.  
  890.         push    ebx
  891.         push    dword[edi + TX_RING_SIZE*sizeof.TDESC]
  892.         mov     dword[edi + TX_RING_SIZE*sizeof.TDESC], 0
  893.         call    KernelFree
  894.         pop     ebx
  895.  
  896.         inc     [device.last_tx]
  897.         and     [device.last_tx], TX_RING_SIZE-1
  898.         jmp     .txdesc_loop
  899.  
  900.   .no_tx:
  901.         pop     edi esi ebx
  902.         xor     eax, eax
  903.         inc     eax
  904.  
  905.         ret
  906.  
  907.  
  908.  
  909.  
  910. ; End of code
  911.  
  912. section '.data' data readable writable align 16
  913. align 4
  914.  
  915. devices         dd 0
  916. version         dd (DRIVER_VERSION shl 16) or (API_VERSION and 0xFFFF)
  917. my_service      db 'I8254X',0                   ; max 16 chars include zero
  918.  
  919. include_debug_strings                           ; All data wich FDO uses will be included here
  920.  
  921. device_list     rd MAX_DEVICES                  ; This list contains all pointers to device structures the driver is handling
  922.  
  923.  
  924.