203 lines
7.3 KiB
C
203 lines
7.3 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.h
|
|
* @brief MAC Driver macros and structures.
|
|
* @addtogroup MAC
|
|
* @{
|
|
*/
|
|
|
|
#ifndef HAL_MAC_H
|
|
#define HAL_MAC_H
|
|
|
|
#if (HAL_USE_MAC == TRUE) || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name MAC configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Enables an event sources for incoming packets.
|
|
*/
|
|
#if !defined(MAC_USE_ZERO_COPY) || defined(__DOXYGEN__)
|
|
#define MAC_USE_ZERO_COPY FALSE
|
|
#endif
|
|
|
|
/**
|
|
* @brief Enables an event sources for incoming packets.
|
|
*/
|
|
#if !defined(MAC_USE_EVENTS) || defined(__DOXYGEN__)
|
|
#define MAC_USE_EVENTS TRUE
|
|
#endif
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Driver state machine possible states.
|
|
*/
|
|
typedef enum {
|
|
MAC_UNINIT = 0, /**< Not initialized. */
|
|
MAC_STOP = 1, /**< Stopped. */
|
|
MAC_ACTIVE = 2 /**< Active. */
|
|
} macstate_t;
|
|
|
|
/**
|
|
* @brief Type of a structure representing a MAC driver.
|
|
*/
|
|
typedef struct MACDriver MACDriver;
|
|
|
|
#include "hal_mac_lld.h"
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Macro Functions
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief Enables the zero-copy API.
|
|
*
|
|
* @param[in] macp pointer to the @p MACDriver object
|
|
* @return The pointer to the @p EventSource structure.
|
|
*
|
|
* @api
|
|
*/
|
|
#if (MAC_USE_EVENTS == TRUE) || defined(__DOXYGEN__)
|
|
#define macGetReceiveEventSource(macp) (&(macp)->rdevent)
|
|
#endif
|
|
|
|
/**
|
|
* @brief Writes to a transmit descriptor's stream.
|
|
*
|
|
* @param[in] tdp pointer to a @p MACTransmitDescriptor structure
|
|
* @param[in] buf pointer to the buffer containing the data to be written
|
|
* @param[in] size number of bytes to be written
|
|
* @return The number of bytes written into the descriptor's
|
|
* stream, this value can be less than the amount
|
|
* specified in the parameter @p size if the maximum frame
|
|
* size is reached.
|
|
*
|
|
* @api
|
|
*/
|
|
#define macWriteTransmitDescriptor(tdp, buf, size) \
|
|
mac_lld_write_transmit_descriptor(tdp, buf, size)
|
|
|
|
/**
|
|
* @brief Reads from a receive descriptor's stream.
|
|
*
|
|
* @param[in] rdp pointer to a @p MACReceiveDescriptor structure
|
|
* @param[in] buf pointer to the buffer that will receive the read data
|
|
* @param[in] size number of bytes to be read
|
|
* @return The number of bytes read from the descriptor's stream,
|
|
* this value can be less than the amount specified in the
|
|
* parameter @p size if there are no more bytes to read.
|
|
*
|
|
* @api
|
|
*/
|
|
#define macReadReceiveDescriptor(rdp, buf, size) \
|
|
mac_lld_read_receive_descriptor(rdp, buf, size)
|
|
|
|
#if (MAC_USE_ZERO_COPY == TRUE) || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Returns a pointer to the next transmit buffer in the descriptor
|
|
* chain.
|
|
* @note The API guarantees that enough buffers can be requested to fill
|
|
* a whole frame.
|
|
*
|
|
* @param[in] tdp pointer to a @p MACTransmitDescriptor structure
|
|
* @param[in] size size of the requested buffer. Specify the frame size
|
|
* on the first call then scale the value down subtracting
|
|
* the amount of data already copied into the previous
|
|
* buffers.
|
|
* @param[out] sizep pointer to variable receiving the real buffer size.
|
|
* The returned value can be less than the amount
|
|
* requested, this means that more buffers must be
|
|
* requested in order to fill the frame data entirely.
|
|
* @return Pointer to the returned buffer.
|
|
*
|
|
* @api
|
|
*/
|
|
#define macGetNextTransmitBuffer(tdp, size, sizep) \
|
|
mac_lld_get_next_transmit_buffer(tdp, size, sizep)
|
|
|
|
/**
|
|
* @brief Returns a pointer to the next receive buffer in the descriptor
|
|
* chain.
|
|
* @note The API guarantees that the descriptor chain contains a whole
|
|
* frame.
|
|
*
|
|
* @param[in] rdp pointer to a @p MACReceiveDescriptor structure
|
|
* @param[out] sizep pointer to variable receiving the buffer size, it is
|
|
* zero when the last buffer has already been returned.
|
|
* @return Pointer to the returned buffer.
|
|
* @retval NULL if the buffer chain has been entirely scanned.
|
|
*
|
|
* @api
|
|
*/
|
|
#define macGetNextReceiveBuffer(rdp, sizep) \
|
|
mac_lld_get_next_receive_buffer(rdp, sizep)
|
|
#endif /* MAC_USE_ZERO_COPY */
|
|
/** @} */
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void macInit(void);
|
|
void macObjectInit(MACDriver *macp);
|
|
void macStart(MACDriver *macp, const MACConfig *config);
|
|
void macStop(MACDriver *macp);
|
|
void macSetAddress(MACDriver *macp, const uint8_t *p);
|
|
msg_t macWaitTransmitDescriptor(MACDriver *macp,
|
|
MACTransmitDescriptor *tdp,
|
|
sysinterval_t timeout);
|
|
void macReleaseTransmitDescriptor(MACTransmitDescriptor *tdp);
|
|
msg_t macWaitReceiveDescriptor(MACDriver *macp,
|
|
MACReceiveDescriptor *rdp,
|
|
sysinterval_t timeout);
|
|
void macReleaseReceiveDescriptor(MACReceiveDescriptor *rdp);
|
|
bool macPollLinkStatus(MACDriver *macp);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_MAC == TRUE */
|
|
|
|
#endif /* HAL_MAC_H */
|
|
|
|
/** @} */
|