| /** |
| \addtogroup INTERFACES |
| \{ |
| \addtogroup FTDF |
| \{ |
| */ |
| |
| /** |
| **************************************************************************************** |
| * @file ad_ftdf_phy_api.h |
| * |
| * @brief FTDF PHY Adapter API |
| * |
| * Copyright (c) 2016, Dialog Semiconductor |
| * All rights reserved. |
| * 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 the copyright holder 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. |
| * |
| * |
| **************************************************************************************** |
| */ |
| |
| #ifndef AD_FTDF_PHY_API_H |
| #define AD_FTDF_PHY_API_H |
| |
| #include "ftdf.h" |
| #include "ad_ftdf_config.h" |
| |
| /** |
| * \brief Initialize adapter - create queues |
| * |
| */ |
| void ad_ftdf_init(void); |
| |
| /** |
| * \brief Set Extended Address |
| * |
| * Sets interface extended address. This is thread safe. |
| * |
| * \param[in] address - The extended address to set |
| */ |
| void ad_ftdf_setExtAddress( FTDF_ExtAddress address); |
| |
| /** |
| * \brief Get Extended Address |
| * |
| * Gets interface extended address. This is thread safe. |
| * |
| * \returns The extended address of the interface |
| */ |
| FTDF_ExtAddress ad_ftdf_getExtAddress( void); |
| |
| /** |
| * \brief Transmits a frame |
| * |
| * Transmits a frame. Params: |
| * |
| * \param[in] frameLength - The total length of the frame passed in bytes |
| * \param[in] frame - a pointer to the passed frame buffer |
| * \param[in] channel - The channel to use for transmission in [11, 26] |
| * \param[in] csmaSuppress - If true, csma protocol (i.e. CCA) will not be performed |
| * \param[in] pti - Packet Traffic Information that will be used for this transaction. |
| */ |
| FTDF_Status ad_ftdf_send_frame_simple( FTDF_DataLength frameLength, |
| FTDF_Octet* frame, |
| FTDF_ChannelNumber channel, |
| FTDF_PTI pti, |
| FTDF_Boolean csmaSuppress); |
| |
| /** |
| * \brief Instructs the MAC and PHY to go to sleep |
| * |
| * \param[in] allow_deferred_sleep - If true, then if the MAC cannot go to sleep immediately |
| * (e.g. a transmission is pending), the MAC will go to sleep |
| * as soon as possible. If false, and the MAC cannot go to sleep |
| * immediately, sleep will be aborted. |
| */ |
| void ad_ftdf_sleep_when_possible( FTDF_Boolean allow_deferred_sleep); |
| |
| /** |
| * \brief Instructs the MAC and PHY to wakeup, if sleeping |
| * |
| */ |
| void ad_ftdf_wake_up(void); |
| |
| #if FTDF_DBG_BUS_ENABLE |
| /** |
| * \brief Configures GPIO pins for the FTDF debug bus |
| * |
| * Debug bus uses the following (fixed) GPIO pins: |
| * |
| * bit 0: HW_GPIO_PORT_1, HW_GPIO_PIN_4 |
| * bit 1: HW_GPIO_PORT_1, HW_GPIO_PIN_5 |
| * bit 2: HW_GPIO_PORT_1, HW_GPIO_PIN_6 |
| * bit 3: HW_GPIO_PORT_1, HW_GPIO_PIN_7 |
| * bit 4: HW_GPIO_PORT_0, HW_GPIO_PIN_6 |
| * bit 5: HW_GPIO_PORT_0, HW_GPIO_PIN_7 |
| * bit 6: HW_GPIO_PORT_1, HW_GPIO_PIN_3 |
| * bit 7: HW_GPIO_PORT_2, HW_GPIO_PIN_3 |
| */ |
| void ad_ftdf_dbgBusGpioConfig(void); |
| #endif /* FTDF_DBG_BUS_ENABLE */ |
| |
| #endif /* AD_FTDF_PHY_API_H */ |
| |
| /** |
| \} |
| \} |
| \} |
| */ |
| |
