begriffs open source - cmsis/blob - CMSIS/Driver/Include/Driver_ETH_PHY.h

   1 /*
   2  * Copyright (c) 2013-2016 ARM Limited. All rights reserved.
   3  *
   4  * SPDX-License-Identifier: Apache-2.0
   5  *
   6  * Licensed under the Apache License, Version 2.0 (the License); you may
   7  * not use this file except in compliance with the License.
   8  * You may obtain a copy of the License at
   9  *
  10  * http://www.apache.org/licenses/LICENSE-2.0
  11  *
  12  * Unless required by applicable law or agreed to in writing, software
  13  * distributed under the License is distributed on an AS IS BASIS, WITHOUT
  14  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15  * See the License for the specific language governing permissions and
  16  * limitations under the License.
  17  *
  18  * $Date:        7. Mar 2014
  19  * $Revision:    V2.00
  20  *
  21  * Project:      Ethernet PHY (Physical Transceiver) Driver definitions
  22  */
  23
  24 /* History:
  25  *  Version 2.00
  26  *    changed parameter "mode" in function ARM_ETH_PHY_SetMode
  27  *    Changed prefix ARM_DRV -> ARM_DRIVER
  28  *    Changed return values of some functions to int32_t
  29  *  Version 1.10
  30  *    Namespace prefix ARM_ added
  31  *  Version 1.00
  32  *    Initial release
  33  */
  34
  35 #ifndef __DRIVER_ETH_PHY_H
  36 #define __DRIVER_ETH_PHY_H
  37
  38 #include "Driver_ETH.h"
  39
  40 #define ARM_ETH_PHY_API_VERSION ARM_DRIVER_VERSION_MAJOR_MINOR(2,00)  /* API version */
  41
  42
  43 #define _ARM_Driver_ETH_PHY_(n)      Driver_ETH_PHY##n
  44 #define  ARM_Driver_ETH_PHY_(n) _ARM_Driver_ETH_PHY_(n)
  45
  46
  47 /****** Ethernet PHY Mode *****/
  48 #define ARM_ETH_PHY_SPEED_Pos            0
  49 #define ARM_ETH_PHY_SPEED_Msk           (3UL                 << ARM_ETH_PHY_SPEED_Pos)
  50 #define ARM_ETH_PHY_SPEED_10M           (ARM_ETH_SPEED_10M   << ARM_ETH_PHY_SPEED_Pos)  ///< 10 Mbps link speed
  51 #define ARM_ETH_PHY_SPEED_100M          (ARM_ETH_SPEED_100M  << ARM_ETH_PHY_SPEED_Pos)  ///< 100 Mbps link speed
  52 #define ARM_ETH_PHY_SPEED_1G            (ARM_ETH_SPEED_1G    << ARM_ETH_PHY_SPEED_Pos)  ///< 1 Gpbs link speed
  53 #define ARM_ETH_PHY_DUPLEX_Pos           2
  54 #define ARM_ETH_PHY_DUPLEX_Msk          (1UL                 << ARM_ETH_PHY_DUPLEX_Pos)
  55 #define ARM_ETH_PHY_DUPLEX_HALF         (ARM_ETH_DUPLEX_HALF << ARM_ETH_PHY_DUPLEX_Pos) ///< Half duplex link
  56 #define ARM_ETH_PHY_DUPLEX_FULL         (ARM_ETH_DUPLEX_FULL << ARM_ETH_PHY_DUPLEX_Pos) ///< Full duplex link
  57 #define ARM_ETH_PHY_AUTO_NEGOTIATE      (1UL << 3)                                      ///< Auto Negotiation mode
  58 #define ARM_ETH_PHY_LOOPBACK            (1UL << 4)                                      ///< Loop-back test mode
  59 #define ARM_ETH_PHY_ISOLATE             (1UL << 5)                                      ///< Isolate PHY from MII/RMII interface
  60
  61
  62 // Function documentation
  63 /**
  64   \fn          ARM_DRIVER_VERSION ARM_ETH_PHY_GetVersion (void)
  65   \brief       Get driver version.
  66   \return      \ref ARM_DRIVER_VERSION
  67 */
  68 /**
  69   \fn          int32_t ARM_ETH_PHY_Initialize (ARM_ETH_PHY_Read_t  fn_read,
  70                                                ARM_ETH_PHY_Write_t fn_write)
  71   \brief       Initialize Ethernet PHY Device.
  72   \param[in]   fn_read   Pointer to \ref ARM_ETH_MAC_PHY_Read
  73   \param[in]   fn_write  Pointer to \ref ARM_ETH_MAC_PHY_Write
  74   \return      \ref execution_status
  75 */
  76 /**
  77   \fn          int32_t ARM_ETH_PHY_Uninitialize (void)
  78   \brief       De-initialize Ethernet PHY Device.
  79   \return      \ref execution_status
  80 */
  81 /**
  82   \fn          int32_t ARM_ETH_PHY_PowerControl (ARM_POWER_STATE state)
  83   \brief       Control Ethernet PHY Device Power.
  84   \param[in]   state  Power state
  85   \return      \ref execution_status
  86 */
  87 /**
  88   \fn          int32_t ARM_ETH_PHY_SetInterface (uint32_t interface)
  89   \brief       Set Ethernet Media Interface.
  90   \param[in]   interface  Media Interface type
  91   \return      \ref execution_status
  92 */
  93 /**
  94   \fn          int32_t ARM_ETH_PHY_SetMode (uint32_t mode)
  95   \brief       Set Ethernet PHY Device Operation mode.
  96   \param[in]   mode  Operation Mode
  97   \return      \ref execution_status
  98 */
  99 /**
 100   \fn          ARM_ETH_LINK_STATE ARM_ETH_PHY_GetLinkState (void)
 101   \brief       Get Ethernet PHY Device Link state.
 102   \return      current link status \ref ARM_ETH_LINK_STATE
 103 */
 104 /**
 105   \fn          ARM_ETH_LINK_INFO ARM_ETH_PHY_GetLinkInfo (void)
 106   \brief       Get Ethernet PHY Device Link information.
 107   \return      current link parameters \ref ARM_ETH_LINK_INFO
 108 */
 109
 110
 111 typedef int32_t (*ARM_ETH_PHY_Read_t)  (uint8_t phy_addr, uint8_t reg_addr, uint16_t *data); ///< Pointer to \ref ARM_ETH_MAC_PHY_Read : Read Ethernet PHY Register.
 112 typedef int32_t (*ARM_ETH_PHY_Write_t) (uint8_t phy_addr, uint8_t reg_addr, uint16_t  data); ///< Pointer to \ref ARM_ETH_MAC_PHY_Write : Write Ethernet PHY Register.
 113
 114
 115 /**
 116 \brief Access structure of the Ethernet PHY Driver
 117 */
 118 typedef struct _ARM_DRIVER_ETH_PHY {
 119   ARM_DRIVER_VERSION (*GetVersion)   (void);                          ///< Pointer to \ref ARM_ETH_PHY_GetVersion : Get driver version.
 120   int32_t            (*Initialize)   (ARM_ETH_PHY_Read_t  fn_read,
 121                                       ARM_ETH_PHY_Write_t fn_write);  ///< Pointer to \ref ARM_ETH_PHY_Initialize : Initialize PHY Device.
 122   int32_t            (*Uninitialize) (void);                          ///< Pointer to \ref ARM_ETH_PHY_Uninitialize : De-initialize PHY Device.
 123   int32_t            (*PowerControl) (ARM_POWER_STATE state);         ///< Pointer to \ref ARM_ETH_PHY_PowerControl : Control PHY Device Power.
 124   int32_t            (*SetInterface) (uint32_t interface);            ///< Pointer to \ref ARM_ETH_PHY_SetInterface : Set Ethernet Media Interface.
 125   int32_t            (*SetMode)      (uint32_t mode);                 ///< Pointer to \ref ARM_ETH_PHY_SetMode : Set Ethernet PHY Device Operation mode.
 126   ARM_ETH_LINK_STATE (*GetLinkState) (void);                          ///< Pointer to \ref ARM_ETH_PHY_GetLinkState : Get Ethernet PHY Device Link state.
 127   ARM_ETH_LINK_INFO  (*GetLinkInfo)  (void);                          ///< Pointer to \ref ARM_ETH_PHY_GetLinkInfo : Get Ethernet PHY Device Link information.
 128 } const ARM_DRIVER_ETH_PHY;
 129
 130 #endif /* __DRIVER_ETH_PHY_H */