stm32f4xx_hal_eth.c File Reference

ETH HAL module driver. This file provides firmware functions to manage the following functionalities of the Ethernet (ETH) peripheral: More...

#include "stm32f4xx_hal.h"

Detailed Description

ETH HAL module driver. This file provides firmware functions to manage the following functionalities of the Ethernet (ETH) peripheral:

Author

MCD Application Team

• Initialization and de-initialization functions
• IO operation functions
• Peripheral Control functions
• Peripheral State and Errors functions

==============================================================================
                  ##### How to use this driver #####
==============================================================================
  [..]
    (#)Declare a ETH_HandleTypeDef handle structure, for example:
       ETH_HandleTypeDef  heth;

    (#)Fill parameters of Init structure in heth handle

    (#)Call HAL_ETH_Init() API to initialize the Ethernet peripheral (MAC, DMA, ...)

    (#)Initialize the ETH low level resources through the HAL_ETH_MspInit() API:
        (##) Enable the Ethernet interface clock using
             (+++) __HAL_RCC_ETHMAC_CLK_ENABLE();
             (+++) __HAL_RCC_ETHMACTX_CLK_ENABLE();
             (+++) __HAL_RCC_ETHMACRX_CLK_ENABLE();

        (##) Initialize the related GPIO clocks
        (##) Configure Ethernet pin-out
        (##) Configure Ethernet NVIC interrupt (IT mode)

    (#)Initialize Ethernet DMA Descriptors in chain mode and point to allocated buffers:
        (##) HAL_ETH_DMATxDescListInit(); for Transmission process
        (##) HAL_ETH_DMARxDescListInit(); for Reception process

    (#)Enable MAC and DMA transmission and reception:
        (##) HAL_ETH_Start();

    (#)Prepare ETH DMA TX Descriptors and give the hand to ETH DMA to transfer
       the frame to MAC TX FIFO:
       (##) HAL_ETH_TransmitFrame();

    (#)Poll for a received frame in ETH RX DMA Descriptors and get received
       frame parameters
       (##) HAL_ETH_GetReceivedFrame(); (should be called into an infinite loop)

    (#) Get a received frame when an ETH RX interrupt occurs:
       (##) HAL_ETH_GetReceivedFrame_IT(); (called in IT mode only)

    (#) Communicate with external PHY device:
       (##) Read a specific register from the PHY
            HAL_ETH_ReadPHYRegister();
       (##) Write data to a specific RHY register:
            HAL_ETH_WritePHYRegister();

    (#) Configure the Ethernet MAC after ETH peripheral initialization
        HAL_ETH_ConfigMAC(); all MAC parameters should be filled.

    (#) Configure the Ethernet DMA after ETH peripheral initialization
        HAL_ETH_ConfigDMA(); all DMA parameters should be filled.

    -@- The PTP protocol and the DMA descriptors ring mode are not supported
        in this driver

Attention

© COPYRIGHT(c) 2017 STMicroelectronics

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
3. Neither the name of STMicroelectronics nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.