151 lines
4.6 KiB
C
151 lines
4.6 KiB
C
/*
|
|
ChibiOS/RT - Copyright (C) 2006-2007 Giovanni Di Sirio.
|
|
|
|
This file is part of ChibiOS/RT.
|
|
|
|
ChibiOS/RT 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.
|
|
|
|
ChibiOS/RT 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/>.
|
|
*/
|
|
|
|
/**
|
|
* @file templates/spi_lld.h
|
|
* @brief SPI Driver subsystem low level driver header template.
|
|
* @addtogroup SPI_LLD
|
|
* @{
|
|
*/
|
|
|
|
#ifndef _SPI_LLD_H_
|
|
#define _SPI_LLD_H_
|
|
|
|
#if CH_HAL_USE_SPI || defined(__DOXYGEN__)
|
|
|
|
/*===========================================================================*/
|
|
/* Driver constants. */
|
|
/*===========================================================================*/
|
|
|
|
/*===========================================================================*/
|
|
/* Driver pre-compile time settings. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Enables the mutual exclusion APIs on the SPI bus.
|
|
*/
|
|
#if !defined(SPI_USE_MUTUAL_EXCLUSION) || defined(__DOXYGEN__)
|
|
#define SPI_USE_MUTUAL_EXCLUSION TRUE
|
|
#endif
|
|
|
|
/**
|
|
* @brief SPI1 (SSP) driver enable switch.
|
|
* @details If set to @p TRUE the support for SPI0 is included.
|
|
* @note The default is @p TRUE.
|
|
*/
|
|
#if !defined(USE_LPC214x_SPI1) || defined(__DOXYGEN__)
|
|
#define USE_LPC214x_SPI1 TRUE
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Derived constants and error checks. */
|
|
/*===========================================================================*/
|
|
|
|
#if SPI_USE_MUTUAL_EXCLUSION && !CH_USE_MUTEXES && !CH_USE_SEMAPHORES
|
|
#error "SPI_USE_MUTUAL_EXCLUSION requires CH_USE_MUTEXES and/or CH_USE_SEMAPHORES"
|
|
#endif
|
|
|
|
/*===========================================================================*/
|
|
/* Driver data structures and types. */
|
|
/*===========================================================================*/
|
|
|
|
/**
|
|
* @brief Driver configuration structure.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief The chip select line port.
|
|
*/
|
|
ioportid_t spc_ssport;
|
|
/**
|
|
* @brief The chip select line pad number.
|
|
*/
|
|
uint16_t spc_sspad;
|
|
/**
|
|
* @brief SSP CR0 initialization data.
|
|
*/
|
|
uint16_t spc_cr0;
|
|
/**
|
|
* @brief SSP CR1 initialization data.
|
|
*/
|
|
uint16_t spc_cr1;
|
|
/**
|
|
* @brief SSP CPSR initialization data.
|
|
*/
|
|
uint32_t spc_cpsr;
|
|
} SPIConfig;
|
|
|
|
/**
|
|
* @brief Structure representing a SPI driver.
|
|
*/
|
|
typedef struct {
|
|
/**
|
|
* @brief Driver state.
|
|
*/
|
|
spistate_t spd_state;
|
|
#if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
|
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
|
/**
|
|
* @brief Mutex protecting the bus.
|
|
*/
|
|
Mutex spd_mutex;
|
|
#elif CH_USE_SEMAPHORES
|
|
Semaphore spd_semaphore;
|
|
#endif
|
|
#endif /* SPI_USE_MUTUAL_EXCLUSION */
|
|
/**
|
|
* @brief Current configuration data.
|
|
*/
|
|
const SPIConfig *spd_config;
|
|
/* End of the mandatory fields.*/
|
|
} SPIDriver;
|
|
|
|
/*===========================================================================*/
|
|
/* External declarations. */
|
|
/*===========================================================================*/
|
|
|
|
/** @cond never*/
|
|
#if USE_LPC214x_SPI1
|
|
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);
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
/** @endcond*/
|
|
|
|
#endif /* CH_HAL_USE_SPI */
|
|
|
|
#endif /* _SPI_LLD_H_ */
|
|
|
|
/** @} */
|