load_config_params.h

hifn ipsec固件下载工具

/*----------------------------------------------------------------------------*

  Copyright (c) 2005 by Hifn, Inc, Los Gatos, CA, U.S.A.
  All Rights Reserved.

  This  software is furnished to licensee under a software license  agreement
  and may be used and copied only in accordance with the terms and conditions
  of such license and with the inclusion of the above Copyright Notice.  This
  software  or  any  other  copies  thereof may not be provided or  otherwise
  made  available  to any  other person.  No title to and  ownership  of  the
  software   is   hereby   transferred   and   licensee  is  subject  to  all
  confidentiality  provisions set forth in the  software  license  agreement.

  The information in this software is  subject to change without notice.

*-----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*
 * $Id: @(#) load_config_params.h 1.3@(#) $
 *----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------*
 * @file load_config_params.h
 * @brief Interface file load_config_params.
 *
 * Interface file for load_config_params.c, which has code to configure the esc
 * using values found in the configuration files, and has code to wait for
 * the esc to be up and running.
 *
 *----------------------------------------------------------------------------*/

#ifndef CONFIGURE_ESC_H
#define CONFIGURE_ESC_H

/*------------------------------------*
 * Header Include Statements
 *------------------------------------*/

/* Standard includes */

/* Hifn specific includes */
#include "hftc_pub_errors.h"
#include "download_configure.h"

/*------------------------------------*
 * External Constants and Types
 *------------------------------------*/

/*
   The unit array.
     PPCI         MAC Address
     Address    (network byte order)

   The #defines below are indices into a unit table loaded into the esc.
*/
#define DPUINDEX                 0
#define ESCINDEX                 1
#define HOSTINDEX                2
#define NUMBEROFUNITS            3


/*------------------------------------*
 * External Function Prototypes
 *------------------------------------*/

HFTC_Status_t load_config_params(download_param_t   *param_p);

HFTC_Status_t wait_esc(download_param_t   *param_p);

#endif /* CONFIGURE_ESC_H */

/*----------------------------------------------------------------------------*
REV #  DATE       BY    REVISION DESCRIPTION
-----  --------  -----  ------------------------------------------------------
0001   07/06/05   msz   Created.

0002   08/22/05   msz   Moved the indicies of unit array in here so other
                        parts of download_configure could index into a unit
                        table array to obtain PPCI addresses.

0003   10/09/06   rlh   * Renamed file from configure_esc.h ->
                        load_config_params.h and
                        configure_esc -> load_config_params.
                        * Added DPU port MTU params.  Since the port MTU
                        values are a DPU parameter, generalized the
                        config file to not just handle ESC parameters.
                        * Renamed config/escconfig -> config/configparams
                        and changed all related definitions to be
                        consistent w/ new naming scheme:
                        HFTC_ReadESCConfigFile -> HFTC_ReadConfigFile
                        ESC_PARAMETER -> CONFIG_PARAMETER,
                        esc_parameters -> config_params, etc.
*----------------------------------------------------------------------------*/