git.sur5r.net Git - freertos/blob - FreeRTOS/Demo/CORTEX_M4F_ATSAM4E_Atmel_Studio/src/ASF/sam/components/ethernet_phy/documentation.h

   1 /**\r
   2  * \file\r
   3  *\r
   4  * \brief Ethernet Phy management\r
   5  *\r
   6  * Copyright (c) 2012 Atmel Corporation. All rights reserved.\r
   7  *\r
   8  * \asf_license_start\r
   9  *\r
  10  * \page License\r
  11  *\r
  12  * Redistribution and use in source and binary forms, with or without\r
  13  * modification, are permitted provided that the following conditions are met:\r
  14  *\r
  15  * 1. Redistributions of source code must retain the above copyright notice,\r
  16  *    this list of conditions and the following disclaimer.\r
  17  *\r
  18  * 2. Redistributions in binary form must reproduce the above copyright notice,\r
  19  *    this list of conditions and the following disclaimer in the documentation\r
  20  *    and/or other materials provided with the distribution.\r
  21  *\r
  22  * 3. The name of Atmel may not be used to endorse or promote products derived\r
  23  *    from this software without specific prior written permission.\r
  24  *\r
  25  * 4. This software may only be redistributed and used in connection with an\r
  26  *    Atmel microcontroller product.\r
  27  *\r
  28  * THIS SOFTWARE IS PROVIDED BY ATMEL "AS IS" AND ANY EXPRESS OR IMPLIED\r
  29  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF\r
  30  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT ARE\r
  31  * EXPRESSLY AND SPECIFICALLY DISCLAIMED. IN NO EVENT SHALL ATMEL BE LIABLE FOR\r
  32  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  33  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS\r
  34  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)\r
  35  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,\r
  36  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN\r
  37  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE\r
  38  * POSSIBILITY OF SUCH DAMAGE.\r
  39  *\r
  40  * \asf_license_stop\r
  41  *\r
  42  */\r
  43 \r
  44 /**\r
  45  *\r
  46  * \defgroup ethernet_phy_group Ethernet Phy\r
  47  *\r
  48  * This is the common API for Ethernet Phy on ARMs. Additional features are available\r
  49  * in the documentation of the specific modules.\r
  50  *\r
  51  * \section ethernet_phy_group_platform Platform Dependencies\r
  52  *\r
  53  * The ethernet_phy API is partially chip- or platform-specific. While all\r
  54  * platforms provide mostly the same functionality, there are some\r
  55  * variations around how different bus types and clock tree structures\r
  56  * are handled.\r
  57  *\r
  58  * The following functions are available on all platforms, but there may\r
  59  * be variations in the function signature (i.e. parameters) and\r
  60  * behaviour. These functions are typically called by platform-specific\r
  61  * parts of drivers, and applications that aren't intended to be\r
  62  * portable:\r
  63  *   - ethernet_phy_init()\r
  64  *   - ethernet_phy_set_link()\r
  65  *   - ethernet_phy_auto_negotiate()\r
  66  *   - ethernet_phy_reset()\r
  67  *\r
  68  * @{\r
  69  */\r
  70 \r
  71 //! @}\r
  72 \r