182 lines
5.5 KiB
C
182 lines
5.5 KiB
C
/*
|
|
ChibiOS - Copyright (C) 2006..2018 Giovanni Di Sirio
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file hal_mac_lld.h
|
|
* @brief PLATFORM MAC subsystem low level driver header.
|
|
*
|
|
* @addtogroup MAC
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_MAC_LLD_H
|
|
#define HAL_MAC_LLD_H
|
|
|
|
#if (HAL_USE_MAC == TRUE) || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief This implementation supports the zero-copy mode API.
|
|
*/
|
|
#define MAC_SUPPORTS_ZERO_COPY TRUE
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name PLATFORM configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief MAC driver enable switch.
|
|
* @details If set to @p TRUE the support for MAC1 is included.
|
|
* @note The default is @p FALSE.
|
|
*/
|
|
#if !defined(PLATFORM_MAC_USE_MAC1) || defined(__DOXYGEN__)
|
|
#define PLATFORM_MAC_USE_MAC1 FALSE
|
|
#endif
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @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.
|
|
*/
|
|
threads_queue_t tdqueue;
|
|
/**
|
|
* @brief Receive semaphore.
|
|
*/
|
|
threads_queue_t rdqueue;
|
|
#if (MAC_USE_EVENTS == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Receive event.
|
|
*/
|
|
event_source_t 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 (PLATFORM_MAC_USE_MAC1 == TRUE) && !defined(__DOXYGEN__)
|
|
extern MACDriver ETHD1;
|
|
#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 mac_lld_get_transmit_descriptor(MACDriver *macp,
|
|
MACTransmitDescriptor *tdp);
|
|
void mac_lld_release_transmit_descriptor(MACTransmitDescriptor *tdp);
|
|
msg_t mac_lld_get_receive_descriptor(MACDriver *macp,
|
|
MACReceiveDescriptor *rdp);
|
|
void mac_lld_release_receive_descriptor(MACReceiveDescriptor *rdp);
|
|
bool mac_lld_poll_link_status(MACDriver *macp);
|
|
size_t mac_lld_write_transmit_descriptor(MACTransmitDescriptor *tdp,
|
|
uint8_t *buf,
|
|
size_t size);
|
|
size_t mac_lld_read_receive_descriptor(MACReceiveDescriptor *rdp,
|
|
uint8_t *buf,
|
|
size_t size);
|
|
#if MAC_USE_ZERO_COPY == TRUE
|
|
uint8_t *mac_lld_get_next_transmit_buffer(MACTransmitDescriptor *tdp,
|
|
size_t size,
|
|
size_t *sizep);
|
|
const uint8_t *mac_lld_get_next_receive_buffer(MACReceiveDescriptor *rdp,
|
|
size_t *sizep);
|
|
#endif
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_MAC == TRUE */
|
|
|
|
#endif /* HAL_MAC_LLD_H */
|
|
|
|
/** @} */
|