112 lines
4.3 KiB
C
112 lines
4.3 KiB
C
|
/****************************************************************************
|
||
|
|
* include/nuttx/wireless/ieee802154/mrf24j40.h
|
||
|
|
*
|
||
|
|
* Copyright (C) 2014-2016 Sebastien Lorquet. All rights reserved.
|
||
|
|
* Author: Sebastien Lorquet <sebastien@lorquet.fr>
|
||
|
|
*
|
||
|
|
* 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 NuttX 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 OWNER 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 __INCLUDE_NUTTX_WIRELESS_IEEE802154_MRF24J40_H
|
||
|
|
#define __INCLUDE_NUTTX_WIRELESS_IEEE802154_MRF24J40_H
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Included files
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
#include <nuttx/arch.h>
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Public Types
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
/* The MRF24J40 provides interrupts to the MCU via a GPIO pin. The
|
||
|
|
* following structure provides an MCU-independent mechanism for controlling
|
||
|
|
* the MRF24J40 GPIO interrupt.
|
||
|
|
*
|
||
|
|
* The MRF24J40 interrupt is an active low, *level* interrupt. From Datasheet:
|
||
|
|
* "Note 1: The INTEDGE polarity defaults to:
|
||
|
|
* 0 = Falling Edge. Ensure that the inter-
|
||
|
|
* rupt polarity matches the interrupt pin
|
||
|
|
* polarity of the host microcontroller.
|
||
|
|
* Note 2: The INT pin will remain high or low,
|
||
|
|
* depending on INTEDGE polarity setting,
|
||
|
|
* until INTSTAT register is read."
|
||
|
|
*/
|
||
|
|
|
||
|
|
struct mrf24j40_lower_s
|
||
|
|
{
|
||
|
|
int (*attach)(FAR const struct mrf24j40_lower_s *lower, xcpt_t handler);
|
||
|
|
void (*enable)(FAR const struct mrf24j40_lower_s *lower, int state);
|
||
|
|
};
|
||
|
|
|
||
|
|
#ifdef __cplusplus
|
||
|
|
#define EXTERN extern "C"
|
||
|
|
extern "C"
|
||
|
|
{
|
||
|
|
#else
|
||
|
|
#define EXTERN extern
|
||
|
|
#endif
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Public Function Prototypes
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
/****************************************************************************
|
||
|
|
* Function: mrf24j40_init
|
||
|
|
*
|
||
|
|
* Description:
|
||
|
|
* Initialize the IEEE802.15.4 driver. The MRF24J40 device is assumed to be
|
||
|
|
* in the post-reset state upon entry to this function.
|
||
|
|
*
|
||
|
|
* Parameters:
|
||
|
|
* spi - A reference to the platform's SPI driver for the MRF24J40
|
||
|
|
* lower - The MCU-specific interrupt used to control low-level MCU
|
||
|
|
* functions (i.e., MRF24J40 GPIO interrupts).
|
||
|
|
* devno - If more than one MRF24J40 is supported, then this is the
|
||
|
|
* zero based number that identifies the MRF24J40;
|
||
|
|
*
|
||
|
|
* Returned Value:
|
||
|
|
* OK on success; Negated errno on failure.
|
||
|
|
*
|
||
|
|
* Assumptions:
|
||
|
|
*
|
||
|
|
****************************************************************************/
|
||
|
|
|
||
|
|
struct spi_dev_s; /* Forward reference */
|
||
|
|
FAR struct ieee802154_dev_s *mrf24j40_init(FAR struct spi_dev_s *spi,
|
||
|
|
FAR const struct mrf24j40_lower_s *lower);
|
||
|
|
|
||
|
|
#undef EXTERN
|
||
|
|
#ifdef __cplusplus
|
||
|
|
}
|
||
|
|
#endif
|
||
|
|
|
||
|
|
#endif /* __INCLUDE_NUTTX_WIRELESS_IEEE802154_MRF24J40_H */
|