net_icmp.h

MIPS下的boottloader yamon 的源代码

#ifndef NET_ICMP_H
#define NET_ICMP_H

/************************************************************************
 *
 *      NET_ICMP.h
 *
 *      The 'NET_ICMP' module currently implements the ECHO part of
 *      the ICMP layer. It provides services to send and receive
 *      ECHO events.
 *
 *
 * ######################################################################
 *
 * Copyright (c) 1999-2000 MIPS Technologies, Inc. All rights reserved. 
 * 
 * Unpublished rights reserved under the Copyright Laws of the United States of 
 * America. 
 * 
 * This document contains information that is proprietary to MIPS Technologies, 
 * Inc. ("MIPS Technologies"). Any copying, modifying or use of this information 
 * (in whole or in part) which is not expressly permitted in writing by MIPS 
 * Technologies or a contractually-authorized third party is strictly 
 * prohibited. At a minimum, this information is protected under unfair 
 * competition laws and the expression of the information contained herein is 
 * protected under federal copyright laws. Violations thereof may result in 
 * criminal penalties and fines. 
 * MIPS Technologies or any contractually-authorized third party reserves the 
 * right to change the information contained in this document to improve 
 * function, design or otherwise. MIPS Technologies does not assume any 
 * liability arising out of the application or use of this information. Any 
 * license under patent rights or any other intellectual property rights owned 
 * by MIPS Technologies or third parties shall be conveyed by MIPS Technologies 
 * or any contractually-authorized third party in a separate license agreement 
 * between the parties. 
 * The information contained in this document constitutes one or more of the 
 * following: commercial computer software, commercial computer software 
 * documentation or other commercial items. If the user of this information, or 
 * any related documentation of any kind, including related technical data or 
 * manuals, is an agency, department, or other entity of the United States 
 * government ("Government"), the use, duplication, reproduction, release, 
 * modification, disclosure, or transfer of this information, or any related 
 * documentation of any kind, is restricted in accordance with Federal 
 * Acquisition Regulation 12.212 for civilian agencies and Defense Federal 
 * Acquisition Regulation Supplement 227.7202 for military agencies. The use of 
 * this information by the Government is further restricted in accordance with 
 * the terms of the license agreement(s) and/or applicable contract terms and 
 * conditions covering this information from MIPS Technologies or any 
 * contractually-authorized third party. 
 *
 ************************************************************************/




/************************************************************************
 *    Include files
 ************************************************************************/

#include <sysdefs.h>

/************************************************************************
 *  Parameter definitions
*************************************************************************/



/* ICMP ECHO header definitions */
#define ICMP_ECHO_HEADER_SIZE     8     /* total ICMP ECHO header size  */
#define ICMP_ECHO_HEADER_BASE     34    /* header start address 
                                           in ethernet frame            */

/* ICMP ECHO header: Relative offset addresses for each protocol element*/
#define ICMP_ECHO_HEADER_TYPE                     0
#define ICMP_ECHO_HEADER_CODE                     1
#define ICMP_ECHO_HEADER_CHECKSUM                 2
#define ICMP_ECHO_HEADER_IDENTIFICATION           4
#define ICMP_ECHO_HEADER_SEQUENCE                 6
#define ICMP_ECHO_HEADER_DATA                     8

/* ICMP ECHO header: Protocol element values */
#define ICMP_ECHO_HEADER_TYPE_ECHOREQUEST         8
#define ICMP_ECHO_HEADER_TYPE_ECHOREPLY           0
#define ICMP_ECHO_HEADER_CODE_ECHO                0
#define ICMP_ECHO_HEADER_IDENTIFICATION_MIPS      ( ('M'<<8) | ('I') )

#define ICMP_ECHO_HEADER_DATA_MAX_SIZE            1472

#define ICMP_STATE_CLOSED     0x44 /* ICMP is closed for service        */
#define ICMP_STATE_OPEN       0x46 /* ICMP bound to IP                  */

/* prototype for user defined receive handler for a ICMP ECHO SAP */
typedef UINT32 (*t_icmp_echo_usr_receive)( UINT32     src_ip_adr,  /* BE-format */
                                           t_mac_addr *src_mac_adr,/* MAC */
                                           UINT16     sequence,    /* CPU-format */
                                           UINT16     usr_length ) ;

typedef struct icmp_echo_sap_context
{
    t_icmp_echo_usr_receive usr_receive;/* user defined receive handler,
                                           linked to this SAP      */
} t_icmp_echo_sap_context ;


/************************************************************************
 *  NET_ICMP services: 
*************************************************************************/

/************************************************************************
 *
 *                          NET_ICMP_init
 *  Description :
 *  -------------
 *  Initialize the ICMP module.
 *
 *
 *  Parameters :
 *  ------------
 *  -
 *
 *
 *  Return values :
 *  ---------------
 *  'OK'(=0), successfull initialization
 *
 ************************************************************************/
UINT32 NET_ICMP_init( void ) ;


/************************************************************************
 *
 *                          NET_ICMP_ECHO_open
 *  Description :
 *  -------------
 *  Allocate a ICMP-ECHO-SAP and register user context.
 *
 *
 *  Parameters :
 *  ------------
 *  'usr_receive',     IN,    user-receive function to be registered
 *
 *  Return values :
 *  ---------------
 *  'ERROR_NET_ICMP_FATAL_STATE'      A fatal state has been detected in IP.
 *  'ERROR_NET_ICMP_NOT_INITIALIZED'  IP-'init' has not been called.
 *  'OK'(=0),
 *
 *
 ************************************************************************/
UINT32 NET_ICMP_ECHO_open( t_icmp_echo_usr_receive usr_receive ) ;


/************************************************************************
 *
 *                          NET_ICMP_ECHO_close
 *  Description :
 *  -------------
 *  Close  ICMP-ECHO-SAP.
 *
 *
 *  Parameters :
 *  ------------
 *  -
 *
 *
 *  Return values :
 *  ---------------
 *  'OK'(=0),                ICMP ECHO SAP has been closed
 *
 *
 ************************************************************************/
UINT32 NET_ICMP_ECHO_close( void ) ;


/************************************************************************
 *
 *                          NET_ICMP_ECHO_send
 *  Description :
 *  -------------
 *  Request the ICMP ECHO module to send a 'ECHO' datagram
 *  to a specified destination IP-address with a specified
 *  sequence number and length of ECHO user data.
 *
 *
 *  Parameters :
 *  ------------
 *  'ip_adr',           IN,   destination ip address (BE-format)
 *  'mac_adr',          IN,   optional MAC address
 *  'sequence',         IN,   sequence number to assign datagram
 *  'length',           IN,   length of ECHO-data to send
 *
 *
 *  Return values :
 *  ---------------
 *  'OK'(=0) 
 *
 ************************************************************************/
UINT32 NET_ICMP_ECHO_send( UINT32     ip_adr,  /* destination ip address (BE) */
                           t_mac_addr *mac_adr,/* optional MAC destination    */
                           UINT16     sequence,
                           UINT16     length ) ;


#endif /* #ifndef NET_ICMP_H */