231 lines
6.9 KiB
C
231 lines
6.9 KiB
C
/*
|
|
ChibiOS/HAL - Copyright (C) 2014 Derek Mulcahy
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* @file KINETIS/spi_lld.h
|
|
* @brief KINETIS SPI subsystem low level driver header.
|
|
*
|
|
* @addtogroup SPI
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _SPI_LLD_H_
|
|
#define _SPI_LLD_H_
|
|
|
|
#if HAL_USE_SPI || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @name Configuration options
|
|
* @{
|
|
*/
|
|
/**
|
|
* @brief SPI0 driver enable switch.
|
|
* @details If set to @p TRUE the support for SPI0 is included.
|
|
* @note The default is @p FALSE.
|
|
*/
|
|
#if !defined(KINETIS_SPI_USE_SPI0) || defined(__DOXYGEN__)
|
|
#define KINETIS_SPI_USE_SPI0 FALSE
|
|
#endif
|
|
|
|
/**
|
|
* @brief SPI0 interrupt priority level setting.
|
|
*/
|
|
#if !defined(KINETIS_SPI_SPI0_IRQ_PRIORITY) || defined(__DOXYGEN__)
|
|
#define KINETIS_SPI_SPI0_IRQ_PRIORITY 10
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
#define KINETIS_HAS_SPI0 TRUE
|
|
|
|
#if KINETIS_SPI_USE_SPI0 && !KINETIS_HAS_SPI0
|
|
#error "SPI0 not present in the selected device"
|
|
#endif
|
|
|
|
#if !KINETIS_SPI_USE_SPI0
|
|
#error "SPI driver activated but no SPI peripheral assigned"
|
|
#endif
|
|
|
|
#if KINETIS_SPI_USE_SPI0 && \
|
|
!CORTEX_IS_VALID_KERNEL_PRIORITY(KINETIS_SPI_SPI0_IRQ_PRIORITY)
|
|
#error "Invalid IRQ priority assigned to SPI0"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Type of a structure representing an SPI driver.
|
|
*/
|
|
typedef struct SPIDriver SPIDriver;
|
|
|
|
/**
|
|
* @brief SPI notification callback type.
|
|
*
|
|
* @param[in] spip pointer to the @p SPIDriver object triggering the
|
|
* callback
|
|
*/
|
|
typedef void (*spicallback_t)(SPIDriver *spip);
|
|
|
|
/**
|
|
* @brief Driver configuration structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Operation complete callback or @p NULL.
|
|
*/
|
|
spicallback_t end_cb;
|
|
/* End of the mandatory fields.*/
|
|
/**
|
|
* @brief The chip select line port - when not using pcs.
|
|
*/
|
|
ioportid_t ssport;
|
|
/**
|
|
* @brief The chip select line pad number - when not using pcs.
|
|
*/
|
|
uint16_t sspad;
|
|
/**
|
|
* @brief SPI initialization data.
|
|
*/
|
|
uint32_t tar0;
|
|
} SPIConfig;
|
|
|
|
/**
|
|
* @brief Structure representing a SPI driver.
|
|
*/
|
|
struct SPIDriver {
|
|
/**
|
|
* @brief Driver state.
|
|
*/
|
|
spistate_t state;
|
|
/**
|
|
* @brief Current configuration data.
|
|
*/
|
|
const SPIConfig *config;
|
|
#if SPI_USE_WAIT || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Waiting thread.
|
|
*/
|
|
thread_reference_t thread;
|
|
#endif /* SPI_USE_WAIT */
|
|
#if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Mutex protecting the bus.
|
|
*/
|
|
mutex_t mutex;
|
|
#endif /* SPI_USE_MUTUAL_EXCLUSION */
|
|
#if defined(SPI_DRIVER_EXT_FIELDS)
|
|
SPI_DRIVER_EXT_FIELDS
|
|
#endif
|
|
/* End of the mandatory fields.*/
|
|
/**
|
|
* @brief Pointer to the SPIx registers block.
|
|
*/
|
|
SPI_TypeDef *spi;
|
|
/**
|
|
* @brief Number of bytes/words of data to transfer.
|
|
*/
|
|
size_t count;
|
|
/**
|
|
* @brief Word size in bytes.
|
|
*/
|
|
size_t word_size;
|
|
/**
|
|
* @brief Pointer to the buffer with data to send.
|
|
*/
|
|
const uint8_t *txbuf;
|
|
/**
|
|
* @brief Pointer to the buffer to put received data.
|
|
*/
|
|
uint8_t *rxbuf;
|
|
};
|
|
|
|
/*===========================================================================*/
|
|
/* Driver macros. */
|
|
/*===========================================================================*/
|
|
|
|
/* TAR settings for n bits at SYSCLK / 2 */
|
|
#define KINETIS_SPI_TAR_SYSCLK_DIV_2(n)\
|
|
SPIx_CTARn_FMSZ((n) - 1) | \
|
|
SPIx_CTARn_CPOL | \
|
|
SPIx_CTARn_CPHA | \
|
|
SPIx_CTARn_DBR | \
|
|
SPIx_CTARn_PBR(0) | \
|
|
SPIx_CTARn_BR(0) | \
|
|
SPIx_CTARn_CSSCK(0) | \
|
|
SPIx_CTARn_ASC(0) | \
|
|
SPIx_CTARn_DT(0)
|
|
|
|
/* TAR settings for n bits at SYSCLK / 4096 for debugging */
|
|
#define KINETIS_SPI_TAR_SYSCLK_DIV_4096(n) \
|
|
SPIx_CTARn_FMSZ(((n) - 1)) | \
|
|
SPIx_CTARn_CPOL | \
|
|
SPIx_CTARn_CPHA | \
|
|
SPIx_CTARn_PBR(0) | \
|
|
SPIx_CTARn_BR(0xB) | \
|
|
SPIx_CTARn_CSSCK(0xB) | \
|
|
SPIx_CTARn_ASC(0x7) | \
|
|
SPIx_CTARn_DT(0xB)
|
|
|
|
#define KINETIS_SPI_TAR_8BIT_FAST KINETIS_SPI_TAR_SYSCLK_DIV_2(8)
|
|
#define KINETIS_SPI_TAR_8BIT_SLOW KINETIS_SPI_TAR_SYSCLK_DIV_4096(8)
|
|
|
|
#define KINETIS_SPI_TAR0_DEFAULT KINETIS_SPI_TAR_SYSCLK_DIV_2(8)
|
|
#define KINETIS_SPI_TAR1_DEFAULT KINETIS_SPI_TAR_SYSCLK_DIV_2(8)
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
#if KINETIS_SPI_USE_SPI0 && !defined(__DOXYGEN__)
|
|
extern SPIDriver SPID1;
|
|
#endif
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
void spi_lld_init(void);
|
|
void spi_lld_start(SPIDriver *spip);
|
|
void spi_lld_stop(SPIDriver *spip);
|
|
void spi_lld_select(SPIDriver *spip);
|
|
void spi_lld_unselect(SPIDriver *spip);
|
|
void spi_lld_ignore(SPIDriver *spip, size_t n);
|
|
void spi_lld_exchange(SPIDriver *spip, size_t n,
|
|
const void *txbuf, void *rxbuf);
|
|
void spi_lld_send(SPIDriver *spip, size_t n, const void *txbuf);
|
|
void spi_lld_receive(SPIDriver *spip, size_t n, void *rxbuf);
|
|
uint16_t spi_lld_polled_exchange(SPIDriver *spip, uint16_t frame);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* HAL_USE_SPI */
|
|
|
|
#endif /* _SPI_LLD_H_ */
|
|
|
|
/** @} */
|