OpenRTX/platform/drivers/SPI/spi_mk22.h

74 wiersze
3.1 KiB
C

/***************************************************************************
* Copyright (C) 2021 - 2025 by Federico Amedeo Izzo IU2NUO, *
* Niccolò Izzo IU2KIN *
* Frederik Saraci IU2NRO *
* Silvano Seva IU2KWO *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef SPI_MK22_H
#define SPI_MK22_H
#include <peripherals/spi.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* Instantiate an MK22 SPI master device.
*
* @param name: device name.
* @param peripheral: underlying MCU peripheral.
* @param mutx: pointer to mutex, or NULL.
*/
#define SPI_MK22_DEVICE_DEFINE(name, peripheral, mutx) \
extern int spiMk22_transfer(const struct spiDevice *dev, const void *txBuf, \
void *rxBuf, const size_t size); \
const struct spiDevice name = \
{ \
.transfer = &spiMk22_transfer, \
.priv = peripheral, \
.mutex = mutx \
};
/**
* Initialise an SPI peripheral and driver.
* Is left to application code to change the operating mode and alternate function
* mapping of the corresponding gpio lines.
*
* @param dev: SPI device descriptor.
* @param pbr: value for the baud rate prescaler (see reference manual).
* @param br: value for the baud rate scaler (see reference manual).
* @param flags: SPI configuration flags.
* @return zero on success, a negative error code otherwise.
*/
int spiMk22_init(const struct spiDevice *dev, const uint8_t pbr, const uint8_t br,
const uint8_t flags);
/**
* Shut down an SPI peripheral and driver.
*
* @param dev: SPI device descriptor.
*/
void spiMk22_terminate(const struct spiDevice *dev);
#ifdef __cplusplus
}
#endif
#endif /* SPI_MK22_H */