openbcm

Git mirror of https://github.com/Broadcom-Network-Switching-Software/OpenBCM
git clone git://git.finwo.net/mirror/broadcom/openbcm
Log | Files | Refs | README

merlin16_interface.h (2590B)

      1 /***********************************************************************************
      2  ***********************************************************************************
      3  *                                                                                 *
      4  *  Revision    :     *
      5  *                                                                                 *
      6  *  Description :  Interface functions targeted to IP user                         *
      7  *                                                                                 *
      8  * This license is set out in https://raw.githubusercontent.com/Broadcom-Network-Switching-Software/OpenBCM/master/Legal/LICENSE file.
      9  * 
     10  * Copyright 2007-2019 Broadcom Inc. All rights reserved.                                                           *
     11  *  No portions of this material may be reproduced in any form without             *
     12  *  the written permission of:                                                     *
     13  *      Broadcom Corporation                                                       *
     14  *      5300 California Avenue                                                     *
     15  *      Irvine, CA  92617                                                          *
     16  *                                                                                 *
     17  *  All information contained in this document is Broadcom Corporation             *
     18  *  company private proprietary, and trade secret.                                 *
     19  */
     20 
     21 /*! \mainpage
     22  *
     23  * \section intro_sec Introduction
     24  *
     25  * This documentation files are intended to guide a developer in using the
     26  * Broadcom SerDes core within a larger ecosystem by providing specific API
     27  * function calls which can be used to perform all necessary operations.
     28  *
     29  * The detailed description about the API directory structure, API overview,
     30  * release procedure, and check out process can be found in the Serdes API User Guide
     31  * (https://broadcom.box.com/v/merlin16-common-16nm)
     32  * \n \n
     33  *
     34  * \section API_sec Important API Files
     35  *
     36  * merlin16_interface.h - provides the primary functionality.
     37  *
     38  * merlin16_dependencies.h - defines the functions to be provided by the IP user
     39  *
     40  * \n \n
     41  * Copyright 2014 Broadcom Corporation all rights reserved
     42  */
     43 
     44 /** @file merlin16_interface.h
     45  * Main interface functions provided to IP User
     46  */
     47 
     48 #ifndef MERLIN16_API_INTERFACE_H
     49 #define MERLIN16_API_INTERFACE_H
     50 
     51 #include "merlin16_access.h"
     52 #include "merlin16_config.h"
     53 #include "merlin16_debug_functions.h"
     54 #include "merlin16_diag.h"
     55 #include "merlin16_prbs.h"
     56 #include "merlin16_pwr_mgt.h"
     57 
     58 #endif