sx126x-board.h

Go to the documentation of this file.

/*
  ______                              _
 / _____)             _              | |
( (____  _____ ____ _| |_ _____  ____| |__
 \____ \| ___ |    (_   _) ___ |/ ___)  _ \
 _____) ) ____| | | || |_| ____( (___| | | |
(______/|_____)_|_|_| \__)_____)\____)_| |_|
    (C)2013 Semtech
 
Description: SX126x driver specific target board functions implementation
 
License: Revised BSD License, see LICENSE.TXT file include in the project
 
Maintainer: Miguel Luis and Gregory Cristian
*/
 
/******************************************************************************
 * @file    sx126x-board.h
 * @author  Insight SiP
 * @version V2.0.0
 * @date    30-january-2019
 * @brief   SX126x header compatible with LoraWan/semtech drivers.
 *
 * @attention
 *  THIS SOFTWARE IS PROVIDED BY INSIGHT SIP "AS IS" AND ANY EXPRESS
 *  OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 *  OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 *  DISCLAIMED. IN NO EVENT SHALL INSIGHT SIP 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 __SX126x_ARCH_H__
#define __SX126x_ARCH_H__
 
#include <Arduino.h>
#include "sx126x-debug.h"
 
extern "C"
{
    void SX126xIoInit(void);
 
    void SX126xIoReInit(void);
 
    void SX126xIoIrqInit(DioIrqHandler dioIrq);
 
    void SX126xIoDeInit(void);
 
    void SX126xReset(void);
 
    void SX126xWaitOnBusy(void);
 
    void SX126xWakeup(void);
 
    void SX126xWriteCommand(RadioCommands_t opcode, uint8_t *buffer, uint16_t size);
 
    void SX126xReadCommand(RadioCommands_t opcode, uint8_t *buffer, uint16_t size);
 
    void SX126xWriteRegister(uint16_t address, uint8_t value);
 
    uint8_t SX126xReadRegister(uint16_t address);
 
    void SX126xSetRfTxPower(int8_t power);
 
    uint8_t SX126xGetPaSelect(uint32_t channel);
 
    void SX126xAntSwOn(void);
 
    void SX126xAntSwOff(void);
 
    void SX126xRXena(void);
 
    void SX126xTXena(void);
 
    bool SX126xCheckRfFrequency(uint32_t frequency);
 
    void SX126xGetStats(uint16_t *nb_pkt_received, uint16_t *nb_pkt_crc_error, uint16_t *nb_pkt_length_error);
 
    void SX126xResetStats(void);
 
    extern SX126x_t SX126x;
};
#endif // __SX126x_ARCH_H__