You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
74 lines
2.6 KiB
74 lines
2.6 KiB
/*! \copyright
|
|
Copyright (c) 2018 Brandenburg Tech, LLC
|
|
All right reserved.
|
|
---
|
|
THIS SOFTWARE IS PROVIDED BY BRANDENBURG TECH, LLC 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 BRANDENBURT TECH, LLC
|
|
AND 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.
|
|
|
|
\file ax5043spi_p.h
|
|
\brief Provides an abstraction layer for the SPI interface communicating to the digital transceiver
|
|
*/
|
|
|
|
#ifndef AX5043SPI_P_H_
|
|
#define AX5043SPI_P_H_
|
|
|
|
#include <stdint.h>
|
|
|
|
#define SPI_CHANNEL (0) //!< The default SPI channel for the digital transceiver
|
|
#define SPI_SPEED (32000000) //!< The default SPI bus speed for the digital transceiver
|
|
|
|
/*! \fn void setSpiChannel(int newSpiChannel)
|
|
\brief Set the SPI channel for the digital transceiver.
|
|
|
|
setSpiChannel must be called before initializeSpi(). The default is SPI_CHANNEL.
|
|
\param newSpiChannel The SPI channel for the digital transceiver.
|
|
\sa SPI_CHANNEL
|
|
\sa initializeSpi
|
|
*/
|
|
void setSpiChannel(int newSpiChannel);
|
|
|
|
/*! \fn void setSpiSpeed(int newSpiSpeed)
|
|
\brief Set the SPI bus speed for the digital transceiver.
|
|
|
|
|
|
setSpiSpeed must be called before initializeSpi(). The default is SPI_SPEED.
|
|
\param newSpiSpeed The SPI bus speed for the digital transceiver.
|
|
\sa SPI_SPEED
|
|
\sa initializeSpi
|
|
*/
|
|
void setSpiSpeed(int newSpiSpeed);
|
|
|
|
/*! \fn void initializeSpi()
|
|
\brief Initilize the SPI bus to communicate with the digital transceiver.
|
|
|
|
setSpiChannel() and setSpiSpeed() must both be called before initializeSPI().
|
|
\sa setSpiChannel
|
|
\sa setSpiSpeed
|
|
*/
|
|
void initializeSpi(void);
|
|
|
|
/*! \fn void ax5043WriteReg(uint16_t reg, uint8_t val)
|
|
\brief Write a value to an AX5043 register.
|
|
\param reg The register to write.
|
|
\param val The value to right to the register.
|
|
*/
|
|
void ax5043WriteReg(uint16_t reg, uint8_t val);
|
|
|
|
/*! \fn uint8_t ax5043ReadReg(uint16_t reg)
|
|
\brief Read a value from an AX5043 register.
|
|
\param reg The register to read.
|
|
\return The value read from the register.
|
|
*/
|
|
uint8_t ax5043ReadReg(uint16_t reg);
|
|
|
|
#endif /* AX5043SPI_P_H_ */
|