Subversion Repositories HomeAutomation

Rev

Rev 363 | Blame | Compare with Previous | Last modification | View Log | SVN | RSS feed

  1. /*********************************************************************
  2.  *
  3.  *                  ARP Server Defs for Microchip TCP/IP Stack
  4.  *
  5.  *********************************************************************
  6.  * FileName:        ARPTsk.h
  7.  * Dependencies:    StackTsk.h
  8.  *                  MAC.h
  9.  * Processor:       PIC18, PIC24F, PIC24H, dsPIC30F, dsPIC33F
  10.  * Complier:        Microchip C18 v3.02 or higher
  11.  *                  Microchip C30 v2.01 or higher
  12.  * Company:         Microchip Technology, Inc.
  13.  *
  14.  * Software License Agreement
  15.  *
  16.  * This software is owned by Microchip Technology Inc. ("Microchip")
  17.  * and is supplied to you for use exclusively as described in the
  18.  * associated software agreement.  This software is protected by
  19.  * software and other intellectual property laws.  Any use in
  20.  * violation of the software license may subject the user to criminal
  21.  * sanctions as well as civil liability.  Copyright 2006 Microchip
  22.  * Technology Inc.  All rights reserved.
  23.  *
  24.  * This software is provided "AS IS."  MICROCHIP DISCLAIMS ALL
  25.  * WARRANTIES, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, NOT LIMITED
  26.  * TO MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND
  27.  * INFRINGEMENT.  Microchip shall in no event be liable for special,
  28.  * incidental, or consequential damages.
  29.  *
  30.  *
  31.  * Author               Date    Comment
  32.  *~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33.  * Nilesh Rajbharti     8/20/01 Original        (Rev 1.0)
  34.  * Nilesh Rajbharti     2/9/02  Cleanup
  35.  * Nilesh Rajbharti     5/22/02 Rev 2.0 (See version.log for detail)
  36.  ********************************************************************/
  37.  
  38. #ifndef ARP_TSK_H
  39. #define ARP_TSK_H
  40.  
  41. #include "..\Include\StackTsk.h"
  42. #include "..\Include\MAC.h"
  43.  
  44.  
  45. /*********************************************************************
  46.  * Function:        void ARPInit(void)
  47.  *
  48.  * PreCondition:    None
  49.  *
  50.  * Input:           None
  51.  *
  52.  * Output:          ARP Cache is initialized.
  53.  *
  54.  * Side Effects:    None
  55.  *
  56.  * Overview:        None
  57.  *
  58.  * Note:            None
  59.  ********************************************************************/
  60. void ARPInit(void);
  61.  
  62.  
  63. /*********************************************************************
  64.  * Function:        BOOL ARPProcess(void)
  65.  *
  66.  * PreCondition:    ARP packet is ready in MAC buffer.
  67.  *
  68.  * Input:           None
  69.  *
  70.  * Output:          ARP FSM is executed.
  71.  *
  72.  * Side Effects:    None
  73.  *
  74.  * Overview:        None
  75.  *
  76.  * Note:            None
  77.  ********************************************************************/
  78. BOOL ARPProcess(void);
  79.  
  80.  
  81. /*********************************************************************
  82.  * Function:        void ARPResolve(IP_ADDR* IPAddr)
  83.  *
  84.  * PreCondition:    None
  85.  *
  86.  * Input:           IPAddr  - IP Address to be resolved.
  87.  *
  88.  * Output:          None
  89.  *
  90.  * Side Effects:    None
  91.  *
  92.  * Overview:        An ARP request is sent.
  93.  *
  94.  * Note:
  95.  ********************************************************************/
  96. void ARPResolve(IP_ADDR *IPAddr);
  97.  
  98.  
  99. /*********************************************************************
  100.  * Function:        BOOL ARPIsResolved(IP_ADDR* IPAddr,
  101.  *                                      MAC_ADDR *MACAddr)
  102.  *
  103.  * PreCondition:    None
  104.  *
  105.  * Input:           IPAddr      - IPAddress to be resolved.
  106.  *                  MACAddr     - Buffer to hold corresponding
  107.  *                                MAC Address.
  108.  *
  109.  * Output:          TRUE if given IP Address has been resolved.
  110.  *                  FALSE otherwise.
  111.  *
  112.  * Side Effects:    None
  113.  *
  114.  * Overview:        None
  115.  *
  116.  * Note:            This function is available only when
  117.  *                  STACK_CLIENT_MODE is defined.
  118.  ********************************************************************/
  119. BOOL ARPIsResolved(IP_ADDR *IPAddr, MAC_ADDR *MACAddr);
  120.  
  121.  
  122.  
  123. #endif
  124.