Subversion Repositories Kolibri OS

include "sis900.inc"

include "pcnet32.inc"

; DEBUGGING_STATE enables or disables output of received and transmitted

DEBUGGING_ENABLED           equ     1

dd  0x12111113, rtl8029_probe, rtl8029_reset, rtl8029_poll, rtl8029_transmit

dd  0x70161039, SIS900_probe, SIS900_reset, SIS900_poll, SIS900_transmit

dd  0,0,0,0,0  ; end of list marker, do not remove

endg

PCI_HEADER_TYPE             equ     0x0e  ;8 bit

PCI_BASE_ADDRESS_0          equ     0x10  ;32 bit

PCI_BASE_ADDRESS_5          equ     0x24  ;32 bits

PCI_VENDOR_ID               equ     0x00  ;16 bit

PCI_BASE_ADDRESS_IO_MASK    equ     0xFFFFFFFC

ETHER_IP                    equ     0x0008      ; Reversed from 0800 for intel

ETHER_ARP                   equ     0x0608      ; Reversed from 0806 for intel

ARP_REQ_OPCODE              equ     0x0100

ARP_REP_OPCODE              equ     0x0200

  ; These hold the destination Host identity for ARP responses

  remote_ip_add:      dd  0

  subnet_mask:        dd  0x00ffffff

endg

uglobal

  ; This is used by getMACfromIP

  MACAddress:         db  0,0,0,0,0,0

  gateway_ip:         db  0, 0, 0, 0

  dns_ip:             dd  0

endg

; The follow is the ARP Table.

; This table must be manually updated and the kernel recompilied if

; changes are made to it.

; ARP_TABLE_SIZE defines the size of the table

; ARP_TABLE_ENTRIES defines the number of entries in the table

; Each entry is 10 bytes: 4 Byte IP address, 6 byte MAC Address,

;                         2 bytes status, 2 bytes TTL ( in seconds )

; Empty entries are filled with zeros

; The TTL field is decremented every second, and is deleted when it

; reaches 0. It is refreshed every time a packet is received

; If the TTL field is 0xFFFF it is a permanent entry and is never deleted

; The status field can be the following values

; 0x0000  entry not used

; 0x0001  entry holds a valid mapping

; 0x0002  entry contains an IP address, awaiting ARP response

; 0x0003  No response received to ARP request.

; The last status value is provided to allow the network layer to delete

; a packet that is queued awaiting an ARP response

ARP_NO_ENTRY                equ 0

ARP_VALID_MAPPING           equ 1

ARP_AWAITING_RESPONSE       equ 2

ARP_RESPONSE_TIMEOUT        equ 3

ARP_ENTRY_SIZE              equ     14          ; Number of bytes per entry

ARP_TABLE_SIZE              equ     20          ; Size of table

ARP_TABLE_ENTRIES           equ     0           ; Inital, hardcoded entries

uglobal

  ARPTable:

  times ( ARP_TABLE_SIZE - ARP_TABLE_ENTRIES ) * ARP_ENTRY_SIZE  db 0

endg

iglobal

  NumARP:        db    ARP_TABLE_ENTRIES

endg

;***************************************************************************

;   Function

;      eth_probe

;   Description

;      Searches for an ethernet card. If found, the card is enabled and

;      the ethernet -> IP link established

;

;      ISA bus is currently not supported.

;

;***************************************************************************

eth_probe:

    ; Find a card on the PCI bus, and get it's address

    call    scan_bus                    ; Find the ethernet cards PIC address

    xor     eax, eax

    cmp     [io_addr], eax

    je      ep_00x                      ; Return 0 in eax if no cards found

    call    dword [drvr_probe]          ; Call the drivers probe function

    mov     eax, [io_addr]              ; return a non zero value

ep_00x:

    ret

;***************************************************************************

;   Function

;      ethernet_driver

;

;   Description

;       The ethernet RX and TX handler

;       This is a kernel function, called by stack_handler

;

;***************************************************************************

ethernet_driver:

    ; Do nothing if the driver is inactive

    cmp     [ethernet_active], byte 0

    je      eth_exit

    call    eth_rx

    call    eth_tx

eth_exit:

    ret

;***************************************************************************

;   Function

;      eth_rx

;

;   Description

;      Polls the ethernet card for received data. Extracts if present

;       Depending on the Protocol within the packet:

;         ARP : Pass to ARP_handler. This may result in an ARP reply

;               being tx'ed

;         IP  : Store in an IP buffer

;

;***************************************************************************

eth_rx:

    xor     ax, ax

    mov     [eth_rx_data_len], ax

    call    dword [drvr_poll]       ; Call the drivers poll function

    mov     ax, [eth_rx_data_len]

    cmp     ax, 0

    je      erx_exit

if DEBUGGING_STATE = DEBUGGING_ENABLED

    pusha

    mov     eax, 0                    ;Indicate that this is a received packet

    mov     cx, [eth_rx_data_len]

    mov     esi, Ether_buffer

    cmp     word [esi + 12], ETHER_IP

    jnz     erxd_done

;    cmp     byte [esi + 14 + 9], 0x06  ; TCP

;    jnz     erxd_done

    call    eth_dump

erxd_done:

    popa

end if

    ; Check the protocol. Call appropriate handler

    mov     eax, Ether_buffer

    add     eax, 12                  ; The address of the protocol word

    mov     ax, [eax]

    cmp     ax, ETHER_ARP

    je      erx_001                  ; It is ARP

    cmp     ax, ETHER_IP

    je      erx_002                  ; It's IP

;    inc     dword [dumped_rx_count]

    jmp     erx_exit               ; If not IP or ARP, ignore

erx_001:

    mov     eax, [arp_rx_count]

    inc     eax

    mov     [arp_rx_count], eax

    ; At this point, the packet is still in the Ether_buffer

    call    arp_handler

    jmp     erx_exit

erx_002:

    mov     eax, [ip_rx_count]

    inc     eax

    mov     [ip_rx_count], eax

    ; Check to see if the MAC address is in our arp table

    ; refresh the arp ttl if so

    mov     esi, Ether_buffer

    add     esi, 6

    call    refreshARP

    call    ether_IP_handler

    ; convert buffer pointer eax to the absolute address

    je      etx_send                ; If it is broadcast, just send

    call    getMACfromIP           ; Get the MAC address.

    cmp     eax, ARP_VALID_MAPPING

    jz      etx_send

    ; No valid entry. Are we waiting for a response?

    cmp     eax, ARP_AWAITING_RESPONSE

    jne     etx_001

    mov     eax, NET1OUT_QUEUE

    call    queue

    jmp     etx_exit

etx_001:

    ; HAs the request been sent, but timed out?

    cmp     eax, ARP_RESPONSE_TIMEOUT

    jne     etx_002

    pop     eax

etx_002:

    ; There is no entry. Re queue the request, and ask ARP to send a request

    ; IP address is in edx

    push    edx

    call    arp_request

    pop     ebx

    ; Add an entry in the ARP table, awaiting response

    cmp     byte [NumARP], ARP_TABLE_SIZE

    je      etx_003            ; We cannot add a new entry in the table

    inc     byte [NumARP]

    movzx   eax, byte [NumARP]

    mov     ecx, ARP_ENTRY_SIZE

    mul     ecx

    sub     eax, ARP_ENTRY_SIZE

    mov     [eax + ARPTable], ebx

    xor     ebx, ebx

    mov     [eax + ARPTable + 4], ebx

    mov     [eax + ARPTable + 8], bx

    ; set the status field up - awaiting response

    mov     cl, 0x00

    mov     [eax + ARPTable + 10], cl

    mov     cl, 0x02

    mov     cx, 0x000A

    mov     [eax + ARPTable + 12], cx

etx_003:

    pop     ebx                        ; Get the buffer back

    mov     eax, NET1OUT_QUEUE

    call    queue

    jmp     etx_exit

etx_send:

    xor     ecx, ecx

    mov     ch, [ebx+2]

    mov     cl, [ebx+3]          ; ; Size of IP packet to send

    mov     esi, ebx

    mov     edi, MACAddress

;***************************************************************************

;

;  ARP CODE FOLLOWS

;

;  The ARP code is used by ethernet drivers to translate an destination

;  IP address into an ethernet hardware address. Functions to broadcast

;  requests and handle response are (or will be) here.

;  The IP layer has no knowledge of ARP, as this is a network interface

;  issue

;

;***************************************************************************

;***************************************************************************

;   Function

;      arp_timer

;

;   Description

;      Called every 1s

;      It is responsible for removing expired routes

;      All registers may be destroyed

;

;***************************************************************************

arp_timer:

    ; loop through all the ARP entries, decrementing each one

    ; that doesn't have a TTL of 0xFFFF

    movzx   eax, byte [NumARP]

arp_001:

    cmp     eax, 0

    je      arp_003

    push    eax

    dec     eax

    mov     ecx, ARP_ENTRY_SIZE

    mul     ecx

    cmp     word [ eax + ARPTable + 12], 0xFFFF

    je      arp_002

    cmp     word [ eax + ARPTable + 12], 0

    je      arp_002

    dec     word [eax + ARPTable + 12]

arp_002:

    pop     eax

    dec     eax

    jmp     arp_001

    ; Now, look for entries with a TTL of 0

    ; Valid entries and response timeout entries get removed

    ; awaiting response gets converted into a response timeout, with a

    ; short life time - this allows queued packets to be flushed

arp_003:

    movzx   edx, byte [NumARP]

    cmp     edx, 0

    je      arp_exit

    ; EDX holds the # of entries to search through

    mov     eax, 0

arp_005:

    cmp     word [ eax + ARPTable + 12], 0

    jne     arp_004

    ; If it's status code is 0001 or 0003, delete the entry

    cmp     word [eax + ARPTable + 10], 0x0100

    je      arp_007

    cmp     word [eax + ARPTable + 10], 0x0300

    je      arp_007

    ; The only other valid code is 0002 - indicating a

    ; timeout while waiting for a response. Change the

    ; entry to response timed out

    mov     [eax + ARPTable + 10], word 0x0300

    mov     [eax + ARPTable + 12], word 0x000A

    jmp     arp_004

arp_007:

    ; Delete this entry

    mov     edi, ARPTable

    add     edi, eax

    mov     esi, edi

    add     esi, ARP_ENTRY_SIZE

    mov     ecx, (ARP_TABLE_SIZE - 1) * ARP_ENTRY_SIZE

    sub     ecx, eax

    rep     movsb

    dec     byte [NumARP]

    jmp     arp_006

arp_004:

    add     eax, ARP_ENTRY_SIZE

arp_006:

    dec     edx

    cmp     edx, 0

    jne     arp_005

arp_exit:

    ret

;***************************************************************************

;   Function

;      arp_request

;

;   Description

;      Sends an ARP request on the ethernet

;        The requested IP address is in edx

;      All registers may be destroyed

;

;***************************************************************************

arp_request:

    mov     ebx, Ether_buffer

    mov     ax, 0x0100

    mov     [ebx], ax

    add     ebx, 2

    mov     ax, 0x0008

    mov     [ebx], ax

    add     ebx, 2

    mov     ax, 0x0406

    mov     [ebx], ax

    add     ebx, 2

    mov     ax, 0x0100

    mov     [ebx], ax

    add     ebx, 2

    mov     ecx, node_addr

    mov     eax, [ecx]

    mov     [ebx], eax

    add     ecx, 4

    add     ebx, 4

    mov     ax, [ecx]

    mov     [ebx], ax

    add     ebx, 2

    mov     eax, [stack_ip]

    mov     [ebx], eax

    add     ebx, 4

    xor     eax, eax

    mov     [ebx], eax

    add     ebx, 4

    mov     [ebx], ax

    add     ebx, 2

    mov     [ebx], edx

    ; Now, send it!

    ; Pointer to 48 bit destination address in edi

    ; Type of packet in bx

    ; size of packet in ecx

    ; pointer to packet data in esi

    mov      edi, broadcast_add

;if DEBUGGING_STATE = DEBUGGING_ENABLED

;    pusha

;    mov     eax, 1                    ; Indicate that this is a tx packet

;    mov     ecx, 28

;   mov      esi, Ether_buffer

;    call    eth_dump

;    popa

;end if

    mov     bx, ETHER_ARP

    mov     ecx, 28

    mov     esi, Ether_buffer

    call    dword [drvr_transmit]       ; Call the drivers transmit function

    ret

;***************************************************************************

;   Function

;      arp_handler

;

;   Description

;      Called when an ARP packet is received on the ethernet

;      Header + Data is in Ether_buffer[]

;       It looks to see if the packet is a request to resolve this Hosts

;       IP address. If it is, send the ARP reply packet.

;      This Hosts IP address is in dword [stack_ip]  ( in network format )

;       This Hosts MAC address is in node_addr[6]

;      All registers may be destroyed

;

;***************************************************************************

arp_handler:

    ; Is this a REQUEST?

    ; Is this a request for My Host IP

    ; Yes - So construct a response message.

    ; Send this message to the ethernet card for transmission

    mov     ebx, Ether_buffer

    mov     edx, ebx

    add     edx, 20

    mov     ax, [edx]

    cmp     ax, ARP_REQ_OPCODE      ; Is this a request packet?

    jne     arph_resp            ; No - so test for response

    mov     edx, ebx

    add     edx, 38

    mov     eax, [edx]

    cmp     eax, [stack_ip]         ; Is it looking for my IP address?

    jne     arph_exit            ; No - so quit now

    ; OK, it is a request for my MAC address. Build the frame and send it

    ; Save the important data from the original packet

    ; remote MAC address first

    mov     ecx, remote_hw_add

    mov     edx, ebx

    add     edx, 22               ; edx points to Source h/w address

    mov     eax, [edx]

    mov     [ecx], eax

    add     edx, 4

    add     ecx, 4

    mov     ax, [edx]

    mov     [ecx],ax

    ; and also the remote IP address

    add     edx, 2

    mov     eax,[edx]

    mov     [remote_ip_add], eax

    ; So now we can reuse the packet. ebx still holds the address of

    ; the header + packet

    ; We dont need the header ( first 14 bytes )

    mov     edx, ebx

    add     edx, 20

    mov     ax, ARP_REP_OPCODE

    mov     [edx], ax

    add     edx, 2

    mov     ecx, node_addr

    mov     eax, [ecx]

    mov     [edx], eax

    add     ecx, 4

    add     edx, 4

    mov     ax, [ecx]

    mov     [edx], ax

    add     edx, 2

    mov     eax, [stack_ip]

    mov     [edx], eax

    add     edx, 4

    mov     ecx, remote_hw_add

    mov     eax, [ecx]

    mov     [edx], eax

    add     ecx, 4

    add     edx, 4

    mov     ax, [ecx]

    mov     [edx], ax

    add     edx, 2

    mov     eax, [remote_ip_add]

    mov     [edx], eax

    ; Now, send it!

    ; Pointer to 48 bit destination address in edi

    ; Type of packet in bx

    ; size of packet in ecx

    ; pointer to packet data in esi

    mov     edi, remote_hw_add

;if DEBUGGING_STATE = DEBUGGING_ENABLED

;    pusha

;    mov     eax, 1                    ; Indicate that this is a tx packet

;    mov     ecx, 28

;   mov      esi, Ether_buffer + 14

 ;   call    eth_dump

;    popa

;end if

    mov     bx, ETHER_ARP

    mov     ecx, 28

    mov     esi, Ether_buffer + 14

    call    dword [drvr_transmit]       ; Call the drivers transmit function

    jmp     arph_exit

arph_resp:

    cmp     ax, ARP_REP_OPCODE      ; Is this a replypacket?

    jne     arph_resp            ; No - so quit

    ; This was a reply, probably directed at me.

    ; save the remotes MAC & IP

    mov     ecx, remote_hw_add

    mov     edx, ebx

    add     edx, 22               ; edx points to Source h/w address

    mov     eax, [edx]

    mov     [ecx], eax

    add     edx, 4

    add     ecx, 4

    mov     ax, [edx]

    mov     [ecx],ax

    ; and also the remote IP address

    add     edx, 2

    mov     eax,[edx]

    mov     [remote_ip_add], eax

    ; Now, add an entry in the table for this IP address if it doesn't exist

    push    eax

    movzx   eax, byte [NumARP]

    mov     ecx, ARP_ENTRY_SIZE

    mul     ecx

    pop     edx

    movzx   ecx, byte [NumARP]

    cmp     ecx, 0

    je      arph_002

arph_001:

    sub     eax, ARP_ENTRY_SIZE

    cmp     [eax + ARPTable], edx

    loopnz  arph_001                      ; Return back if non match

    jnz     arph_002                   ; None found, add to end

    mov     ecx, [remote_hw_add]

    mov     [eax + ARPTable + 4], ecx

    mov     cx, [remote_hw_add+4]

    mov     [eax + ARPTable + 8], cx

    ; specify the type - a valid entry

    mov     cl, 0x00

    mov     [eax + ARPTable + 10], cl

    mov     cl, 0x01

    mov     [eax + ARPTable + 11], cl

    ; Initialise the time to live field - 1 hour

    mov     cx, 0x0E10

    mov     [eax + ARPTable + 12], cx

    jmp     arph_exit

arph_002:

    cmp     byte [NumARP], ARP_TABLE_SIZE

    je      arph_exit

    inc     byte [NumARP]

    movzx   eax, byte [NumARP]

    mov     ecx, ARP_ENTRY_SIZE

    mul     ecx

    sub     eax, ARP_ENTRY_SIZE

    mov     ecx, [remote_ip_add]

    mov     [eax + ARPTable], ecx

    mov     ecx, [remote_hw_add]

    mov     [eax + ARPTable + 4], ecx

    mov     cx, [remote_hw_add+4]

    mov     [eax + ARPTable + 8], cx

    mov     cl, 0x00

    mov     [eax + ARPTable + 10], cl

    mov     cl, 0x01

    mov     [eax + ARPTable + 11], cl

    ; Initialise the time to live field - 1 hour

    mov     cx, 0x0E10

    mov     [eax + ARPTable + 12], cx

arph_exit:

    ret

; pointer to MAC in esi

refreshARP:

    mov     ebx, [esi]

    mov     dx, [esi+4]

    push    edx

    movzx   eax, byte [NumARP]

    mov     ecx, ARP_ENTRY_SIZE

    mul     ecx

    pop     edx

    movzx   ecx, byte [NumARP]

    cmp     ecx, 0

    je      rf_exit

rf_001:

    sub     eax, ARP_ENTRY_SIZE

    cmp     [eax + ARPTable+4], ebx

    je      rf_002

    loop    rf_001

    jmp     rf_exit

rf_002:

    cmp     [eax + ARPTable+8], dx

    je      rf_gotone

    loop    rf_001

    jmp     rf_exit

rf_gotone:

    ; Initialise the time to live field - 1 hour

    mov     cx, 0x0E10

    mov     [eax + ARPTable + 12], cx

rf_exit:

    ret

;***************************************************************************

;   Function

;      getMACfromIP

;

;   Description

;       Takes an IP address in edx and scans the ARP table for

;        a matching entry

;       If a match is found, it's MAC address is stored in MACAddress.

;      Otherwise the value 0 is writen to MACAddress

;      eax holds ARP table entry status code ( ARP_ )

;      ebx unchanged

;

;***************************************************************************

getMACfromIP:

    ; first, check destination IP to see if it is on 'this' network.

    ; The test is:

    ; if ( destIP & subnet_mask == stack_ip & subnet_mask )

    ;   desitnation is local

    ; else

    ;  destination is remote, so pass to gateway

    mov     eax, edx

    and     eax, [subnet_mask]

    mov     ecx, [stack_ip]

    and     ecx, [subnet_mask]

    cmp     eax, ecx

    je      gm0

    mov     edx, [gateway_ip]

gm0:

    push    edx

    xor     eax, eax

    mov     [MACAddress], eax

    mov     [MACAddress + 4], ax

    movzx   eax, byte [NumARP]

    mov     ecx, ARP_ENTRY_SIZE

    mul     ecx

    pop     edx

    movzx   ecx, byte [NumARP]

    cmp     ecx, 0

    je      gm_none

gm1:

    sub     eax, ARP_ENTRY_SIZE

    cmp     [eax + ARPTable], edx

    loopnz  gm1                      ; Return back if non match

    jnz     gm_none                   ; Quit if none found

    ; eax holds index

    mov     ecx, [eax + ARPTable + 4]

    mov     [MACAddress], ecx

    mov     cx, [eax + ARPTable + 8]

    mov     [MACAddress+4], cx

    ; Return the entry status in eax

    mov     ch, [eax + ARPTable + 10]

    mov     cl, [eax + ARPTable + 11]

    movzx   eax, cx

    jmp     gm_exit

gm_none:

    mov     eax, ARP_NO_ENTRY

gm_exit:

    ret

;***************************************************************************

;

;  PCI CODE FOLLOWS

;

;  the following functions provide access to the PCI interface.

;  These functions are used by scan_bus, and also some ethernet drivers

;

;***************************************************************************

;***************************************************************************

;   Function

;      config_cmd

;

;   Description

;       creates a command dword  for use with the PCI bus

;       bus # in ebx

;      devfn in ecx

;       where in edx

;

;      command dword returned in eax

;       Only eax destroyed

;***************************************************************************

config_cmd:

    push    ecx

    mov     eax, ebx

    shl     eax, 16

    or      eax, 0x80000000

    shl     ecx, 8

    or      eax, ecx

    pop     ecx

    or      eax, edx

    and     eax, 0xFFFFFFFC

    ret

;***************************************************************************

;   Function

;      pcibios_read_config_byte

;

;   Description

;       bus # in ebx

;      devfn in ecx

;       where in edx ( ls 16 bits significant )

;

;      byte returned in al ( rest of eax zero )

;       Only eax/edx destroyed

;***************************************************************************

pcibios_read_config_byte:

    call    config_cmd

    push    dx

    mov     dx, 0xCF8

    out     dx, eax

    pop     dx

    xor     eax, eax

    and     dx, 0x03

    add     dx, 0xCFC

;   and     dx, 0xFFC

    in      al, dx

    ret

;***************************************************************************

;   Function

;   Description

;       reads a word from the PCI config space

;      devfn in ecx

;       where in edx ( ls 16 bits significant )

;

;      word returned in ax ( rest of eax zero )

;       Only eax/edx destroyed

;***************************************************************************

pcibios_read_config_word:

    call    config_cmd

    push    dx

    mov     dx, 0xCF8

    out     dx, eax

    pop     dx

    xor     eax, eax

    and     dx, 0x02

    add     dx, 0xCFC

;   and     dx, 0xFFC

    in      ax, dx

    ret

;***************************************************************************

;      pcibios_read_config_dword

;   Description

;       reads a dword from the PCI config space

;       where in edx ( ls 16 bits significant )

;       Only eax/edx destroyed

    push    edx

    push    dx

    mov     dx, 0xCF8

    pop     dx

    xor     eax, eax

    mov     dx, 0xCFC

    in      eax, dx

    pop     edx

    ret

;***************************************************************************

;   Function

;      pcibios_write_config_byte

;

;   Description

;       write a byte in al to the PCI config space

;       bus # in ebx

;      devfn in ecx

;       where in edx ( ls 16 bits significant )

;

;       Only eax/edx destroyed

;***************************************************************************

pcibios_write_config_byte:

    push    ax

    call    config_cmd

    push    dx

    mov     dx, 0xCF8

    out     dx, eax

    pop     dx

    pop     ax

    and     dx, 0x03

    add     dx, 0xCFC

    out     dx, al

    ret

;***************************************************************************

;   Function

;      pcibios_write_config_word

;

;   Description

;       write a word in ax to the PCI config space

;       bus # in ebx

;      devfn in ecx

;       where in edx ( ls 16 bits significant )

;

;       Only eax/edx destroyed

;***************************************************************************

pcibios_write_config_word: