201 lines
5.9 KiB
C
201 lines
5.9 KiB
C
/*
|
|
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
|
|
2011 Giovanni Di Sirio.
|
|
|
|
This file is part of ChibiOS/RT.
|
|
|
|
ChibiOS/RT is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 3 of the License, or
|
|
(at your option) any later version.
|
|
|
|
ChibiOS/RT is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
/**
|
|
* @file STM32/mac_lld.h
|
|
* @brief STM32 low level MAC driver header.
|
|
*
|
|
* @addtogroup MAC
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _MAC_LLD_H_
|
|
#define _MAC_LLD_H_
|
|
|
|
#if HAL_USE_MAC || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Number of available transmit buffers.
|
|
*/
|
|
#if !defined(MAC_TRANSMIT_BUFFERS) || defined(__DOXYGEN__)
|
|
#define MAC_TRANSMIT_BUFFERS 2
|
|
#endif
|
|
|
|
/**
|
|
* @brief Number of available receive buffers.
|
|
*/
|
|
#if !defined(MAC_RECEIVE_BUFFERS) || defined(__DOXYGEN__)
|
|
#define MAC_RECEIVE_BUFFERS 2
|
|
#endif
|
|
|
|
/**
|
|
* @brief Maximum supported frame size.
|
|
*/
|
|
#if !defined(MAC_BUFFERS_SIZE) || defined(__DOXYGEN__)
|
|
#define MAC_BUFFERS_SIZE 1518
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Type of an STM32 Ethernet receive descriptor.
|
|
*/
|
|
typedef struct {
|
|
volatile uint32_t rdes0;
|
|
volatile uint32_t rdes1;
|
|
volatile uint32_t rdes2;
|
|
volatile uint32_t rdes3;
|
|
} stm32_eth_rx_descriptor_t;
|
|
|
|
/**
|
|
* @brief Type of an STM32 Ethernet transmit descriptor.
|
|
*/
|
|
typedef struct {
|
|
volatile uint32_t tdes0;
|
|
volatile uint32_t tdes1;
|
|
volatile uint32_t tdes2;
|
|
volatile uint32_t tdes3;
|
|
} stm32_eth_tx_descriptor_t;
|
|
|
|
/**
|
|
* @brief Driver configuration structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief MAC address.
|
|
*/
|
|
uint8_t *mac_address;
|
|
/* End of the mandatory fields.*/
|
|
} MACConfig;
|
|
|
|
/**
|
|
* @brief Structure representing a MAC driver.
|
|
*/
|
|
struct MACDriver {
|
|
/**
|
|
* @brief Driver state.
|
|
*/
|
|
macstate_t state;
|
|
/**
|
|
* @brief Current configuration data.
|
|
*/
|
|
const MACConfig *config;
|
|
/**
|
|
* @brief Transmit semaphore.
|
|
*/
|
|
Semaphore tdsem;
|
|
/**
|
|
* @brief Receive semaphore.
|
|
*/
|
|
Semaphore rdsem;
|
|
#if MAC_USE_EVENTS || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Receive event.
|
|
*/
|
|
EventSource rdevent;
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
};
|
|
|
|
/**
|
|
* @brief Structure representing a transmit descriptor.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Current write offset.
|
|
*/
|
|
size_t offset;
|
|
/**
|
|
* @brief Available space size.
|
|
*/
|
|
size_t size;
|
|
/* End of the mandatory fields.*/
|
|
} MACTransmitDescriptor;
|
|
|
|
/**
|
|
* @brief Structure representing a receive descriptor.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Current read offset.
|
|
*/
|
|
size_t offset;
|
|
/**
|
|
* @brief Available data size.
|
|
*/
|
|
size_t size;
|
|
/* End of the mandatory fields.*/
|
|
} MACReceiveDescriptor;
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if !defined(__DOXYGEN__)
|
|
extern MACDriver ETH1;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void mac_lld_init(void);
|
|
void mac_lld_start(MACDriver *macp);
|
|
void mac_lld_stop(MACDriver *macp);
|
|
msg_t max_lld_get_transmit_descriptor(MACDriver *macp,
|
|
MACTransmitDescriptor *tdp);
|
|
size_t mac_lld_write_transmit_descriptor(MACTransmitDescriptor *tdp,
|
|
uint8_t *buf,
|
|
size_t size);
|
|
void mac_lld_release_transmit_descriptor(MACTransmitDescriptor *tdp);
|
|
msg_t max_lld_get_receive_descriptor(MACDriver *macp,
|
|
MACReceiveDescriptor *rdp);
|
|
size_t mac_lld_read_receive_descriptor(MACReceiveDescriptor *rdp,
|
|
uint8_t *buf,
|
|
size_t size);
|
|
void mac_lld_release_receive_descriptor(MACReceiveDescriptor *rdp);
|
|
bool_t mac_lld_poll_link_status(MACDriver *macp);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_MAC */
|
|
|
|
#endif /* _MAC_LLD_H_ */
|
|
|
|
/** @} */
|