WebSVN – Kolibri OS – Diff – /kernel/trunk/network/ARP.inc

 ;;          GNU GENERAL PUBLIC LICENSE                             ;;
 ;;             Version 2, June- 1991                               ;;
 ;;                                                                 ;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
-$Revision: 5522 $
+$Revision: 6011 $
 ARP_NO_ENTRY            = 0
 ARP_VALID_MAPPING       = 1
 endg
-;-----------------------------------------------------------------
-;
-; ARP_init
+;-----------------------------------------------------------------;
-;
+;                                                                 ;
-;  This function resets all ARP variables
+; arp_init: Resets all ARP variables.                             ;
 ;                                                                 ;
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
-macro ARP_init {
+macro arp_init {
         xor     eax, eax
-        mov     edi, ARP_entries_num
+        mov     edi, ARP_entries_num
         mov     ecx, 4*NET_DEVICES_MAX
-        rep stosd
+        rep stosd
-}
+}
 ;---------------------------------------------------------------------------
 ;-----------------------------------------------------------------;
-; ARP_decrease_entry_ttls
+;                                                                 ;
   .time_out:
         cmp     [esi + ARP_entry.Status], ARP_AWAITING_RESPONSE
         je      .response_timeout
         push    esi edi ecx
-        call    ARP_del_entry
+        call    arp_del_entry
         pop     ecx edi esi
         jb      .loop_outer
 }
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
-;
+;                                                                 ;
-; ARP_input
+; arp_input                                                       ;
-;
+;                                                                 ;
-;  IN:  Pointer to buffer in [esp]
+;  IN:  [esp] = Pointer to buffer                                 ;
-;       size of buffer in [esp+4]
+;       [esp+4] = size of buffer                                  ;
+;       ecx = packet size (without ethernet header)               ;
-;       packet size (without ethernet header) in ecx
+;       edx = packet ptr                                          ;
-;       packet ptr in edx
+;       ebx = device ptr                                          ;
-;       device ptr in ebx
+;                                                                 ;
-;  OUT: /
+;  OUT: /                                                         ;
-;
+;                                                                 ;
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
 align 4
-ARP_input:
+arp_input:
 ;-----------------------------------------
 ; Check validity and print some debug info
         cmp     ecx, sizeof.ARP_header
         inc     [ARP_CONFLICTS + edi]
         DEBUGF  DEBUG_NETWORK_VERBOSE, "ARP_input: IP address conflict detected!\n"
   .exit:
         DEBUGF  DEBUG_NETWORK_VERBOSE, "ARP_input: exiting\n"
-        call    NET_BUFF_free
+        call    net_buff_free
         ret
-;---------------------------------------------------------------------------
+;-----------------------------------------------------------------;
-;
+;                                                                 ;
-; ARP_output_request
+; arp_output_request                                              ;
-;
+;                                                                 ;
-; IN:   ebx = device ptr
+;  IN:  ebx = device ptr                                          ;
-;       eax = IP
+;       eax = IP                                                  ;
-; OUT: /
+;                                                                 ;
-;       scratched: probably everything
+; OUT:  scratched: probably everything                            ;
 ;                                                                 ;
-;---------------------------------------------------------------------------
+;-----------------------------------------------------------------;
 align 4
-ARP_output_request:
+arp_output_request:
         push    eax
         DEBUGF  DEBUG_NETWORK_VERBOSE, "ARP_output_request: ip=%u.%u.%u.%u device=0x%x\n",\
         [esp]:1, [esp + 1]:1, [esp + 2]:1, [esp + 3]:1, ebx
         mov     ax, ETHER_PROTO_ARP
         mov     ecx, sizeof.ARP_header
         mov     edx, ETH_BROADCAST              ; broadcast mac
         lea     esi, [ebx + ETH_DEVICE.mac]     ; SenderMac
         movsw                                   ;
         movsd                                   ;
         push    edi
-        call    NET_ptr_to_num4
+        call    net_ptr_to_num4
         inc     [ARP_PACKETS_TX + edi]          ; assume we will succeed
         lea     esi, [IP_LIST + edi]            ; SenderIP
         pop     edi
         add     esp, 4
         DEBUGF  DEBUG_NETWORK_ERROR, "ARP_output_request: send failed\n"
         ret
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
-;
+;                                                                 ;
-; ARP_add_entry (or update)
+; arp_add_entry: Add or update an entry in the ARP table.         ;
-;
+;                                                                 ;
+;  IN:  esi = ptr to entry (can easily be made on the stack)      ;
-; IN:  esi = ptr to entry (can easily be made on the stack)
+;       edi = device num*4                                        ;
+;                                                                 ;
-;      edi = device num*4
+; OUT:  eax = entry number on success                             ;
-; OUT: eax = entry #, -1 on error
+;       eax = -1 on error                                         ;
-;      esi = ptr to newly created entry
+;       esi = ptr to newly created entry                          ;
 ;                                                                 ;
-;-----------------------------------------------------------------      ; TODO: use a mutex
+;-----------------------------------------------------------------;
+align 4
+arp_add_entry:
 align 4
-ARP_add_entry:
+; TODO: use a mutex to lock ARP table
   .full:
         mov     eax, -1
         ret
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
-;
+;                                                                 ;
-; ARP_del_entry
+; arp_del_entry: Remove an entry from the ARP table.              ;
-;
+;                                                                 ;
+; IN:   esi = ptr to arp entry                                    ;
-; IN:   esi = ptr to arp entry
+;       edi = device number                                       ;
-;       edi = device number
+;                                                                 ;
-; OUT:  /
+; OUT:  /                                                         ;
 ;                                                                 ;
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
+align 4
+arp_del_entry:
-align 4
-ARP_del_entry:
+; TODO: use a mutex to lock ARP table
-        DEBUGF  DEBUG_NETWORK_VERBOSE, "ARP_del_entry: entry=%x entrys=%u\n", esi, [ARP_entries_num + 4*edi]
+        DEBUGF  DEBUG_NETWORK_VERBOSE, "ARP_del_entry: entry=0x%x entrys=%u\n", esi, [ARP_entries_num + 4*edi]
         DEBUGF  DEBUG_NETWORK_VERBOSE, "ARP_del_entry: IP=%u.%u.%u.%u\n", \
-;-----------------------------------------------------------------
-;
-; ARP_IP_to_MAC
+;-----------------------------------------------------------------;
+;                                                                 ;
-;
+; arp_ip_to_mac: Translate an IP address to a MAC address.        ;
+;                                                                 ;
-;  This function translates an IP address to a MAC address
+;  IN:  eax = IPv4 address                                        ;
-;
+;       edi = device number * 4                                   ;
-;  IN:  eax = IPv4 address
+;                                                                 ;
-;       edi = device number * 4
+;  OUT: eax = -1 on error                                         ;
-;  OUT: eax = -1 on error, -2 means request send
+;       eax = -2 when request send                                ;
-;      else, ax = first two bytes of mac (high 16 bits of eax will be 0)
+;       eax = first two bytes of mac on success                   ;
-;       ebx = last four bytes of mac
+;       ebx = last four bytes of mac on success                   ;
-;       edi = unchanged
+;       edi = unchanged                                           ;
 ;                                                                 ;
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
 align 4
 ; Now craft the ARP entry on the stack
         pushw   ARP_REQUEST_TTL         ; TTL
         pushw   ARP_AWAITING_RESPONSE   ; status
         pushd   0                       ; mac
         pushw   0
-        pushd   eax                     ; ip
+        pushd   eax                     ; IP
         mov     esi, esp
 ; Add it to the list
-        call    ARP_add_entry
+        call    arp_add_entry
 ; Delete the temporary entry
 ; Now send a request packet on the network
         pop     edi eax                 ; IP in eax, device number in ebx, for ARP_output_request
         push    esi edi
         mov     ebx, [NET_DRV_LIST + edi]
-        call    ARP_output_request
+        call    arp_output_request
         pop     edi esi
   .found_it:
         cmp     [esi + ARP_entry.Status], ARP_VALID_MAPPING             ; Does it have a MAC assigned?
         mov     eax, 0x0000ffff
         mov     ebx, 0xffffffff
         ret
-;-----------------------------------------------------------------
-;
-; ARP_API
+;-----------------------------------------------------------------;
-;
+;                                                                 ;
-; This function is called by system function 76
+; arp_api: Part of system function 76.                            ;
-;
+;                                                                 ;
-; IN:  subfunction number in bl
+;  IN:  bl = subfunction number                                   ;
-;      device number in bh
+;       bh = device number                                        ;
-;      ecx, edx, .. depends on subfunction
+;       ecx, edx, .. depends on subfunction                       ;
-;
+;                                                                 ;
-; OUT:  ?
+; OUT:  depends on subfunction                                    ;
 ;                                                                 ;
-;-----------------------------------------------------------------
+;-----------------------------------------------------------------;
 align 4
-ARP_api:
+arp_api:
         ret
   .write:
         ; esi = pointer to buffer
         mov     edi, eax
-        call    ARP_add_entry           ; out: eax = entry number, -1 on error
+        call    arp_add_entry           ; out: eax = entry number, -1 on error
         ret
   .remove:
         ; ecx = # entry
         cmp     ecx, [ARP_entries_num + eax]
         jae     .error
         imul    ecx, sizeof.ARP_entry
         lea     esi, [ARP_table + ecx]
         mov     edi, eax
         shr     edi, 2
-        call    ARP_del_entry
+        call    arp_del_entry
         ret
   .send_announce:
         mov     ebx, [NET_DRV_LIST + eax]

Subversion Repositories Kolibri OS

(root)/kernel/trunk/network/ARP.inc – Rev 5522 → 6011