2009-12-19 11:10:08 +00:00
|
|
|
/*
|
2011-03-18 18:38:08 +00:00
|
|
|
ChibiOS/RT - Copyright (C) 2006,2007,2008,2009,2010,
|
|
|
|
2011 Giovanni Di Sirio.
|
2009-12-19 11:10:08 +00:00
|
|
|
|
|
|
|
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/>.
|
|
|
|
*/
|
|
|
|
|
|
|
|
/**
|
2010-10-04 17:16:18 +00:00
|
|
|
* @file LPC214x/spi_lld.h
|
|
|
|
* @brief LPC214x low level SPI driver header.
|
|
|
|
*
|
2010-10-26 17:39:29 +00:00
|
|
|
* @addtogroup SPI
|
2009-12-19 11:10:08 +00:00
|
|
|
* @{
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _SPI_LLD_H_
|
|
|
|
#define _SPI_LLD_H_
|
|
|
|
|
2010-11-01 17:29:56 +00:00
|
|
|
#if HAL_USE_SPI || defined(__DOXYGEN__)
|
2009-12-19 11:10:08 +00:00
|
|
|
|
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver constants. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
2011-03-18 18:38:08 +00:00
|
|
|
* @brief Hardware FIFO depth.
|
2010-10-17 09:13:43 +00:00
|
|
|
*/
|
|
|
|
#define LPC214x_SSP_FIFO_DEPTH 8
|
|
|
|
|
2009-12-19 11:10:08 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver pre-compile time settings. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
|
|
|
/**
|
2010-10-17 09:13:43 +00:00
|
|
|
* @brief SPI1 driver enable switch.
|
|
|
|
* @details If set to @p TRUE the support for SSP is included.
|
2010-10-04 17:16:18 +00:00
|
|
|
* @note The default is @p TRUE.
|
2009-12-19 11:10:08 +00:00
|
|
|
*/
|
2010-10-17 09:13:43 +00:00
|
|
|
#if !defined(LPC214x_SPI_USE_SSP) || defined(__DOXYGEN__)
|
|
|
|
#define LPC214x_SPI_USE_SSP TRUE
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief SSP interrupt priority level setting.
|
|
|
|
*/
|
2011-01-06 16:34:20 +00:00
|
|
|
#if !defined(LPC214x_SPI_SSP_IRQ_PRIORITY) || defined(__DOXYGEN__)
|
2010-10-17 09:13:43 +00:00
|
|
|
#define LPC214x_SPI_SSP_IRQ_PRIORITY 4
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @brief Overflow error hook.
|
|
|
|
* @details The default action is to stop the system.
|
|
|
|
*/
|
|
|
|
#if !defined(LPC214x_SPI_SSP_ERROR_HOOK) || defined(__DOXYGEN__)
|
|
|
|
#define LPC214x_SPI_SSP_ERROR_HOOK() chSysHalt()
|
2009-12-19 11:10:08 +00:00
|
|
|
#endif
|
|
|
|
|
|
|
|
/*===========================================================================*/
|
|
|
|
/* Derived constants and error checks. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2010-10-17 09:13:43 +00:00
|
|
|
#if !LPC214x_SPI_USE_SSP
|
|
|
|
#error "SPI driver activated but no SPI peripheral assigned"
|
|
|
|
#endif
|
|
|
|
|
2009-12-19 11:10:08 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver data structures and types. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
|
|
|
* @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);
|
|
|
|
|
2009-12-19 11:10:08 +00:00
|
|
|
/**
|
2010-10-04 17:16:18 +00:00
|
|
|
* @brief Driver configuration structure.
|
2009-12-19 11:10:08 +00:00
|
|
|
*/
|
|
|
|
typedef struct {
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
|
|
|
* @brief Operation complete callback or @p NULL.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
spicallback_t end_cb;
|
2010-10-17 09:13:43 +00:00
|
|
|
/* End of the mandatory fields.*/
|
2009-12-19 11:10:08 +00:00
|
|
|
/**
|
|
|
|
* @brief The chip select line port.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
ioportid_t ssport;
|
2009-12-19 11:10:08 +00:00
|
|
|
/**
|
|
|
|
* @brief The chip select line pad number.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
uint16_t sspad;
|
2009-12-19 11:10:08 +00:00
|
|
|
/**
|
|
|
|
* @brief SSP CR0 initialization data.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
uint16_t cr0;
|
2009-12-19 11:10:08 +00:00
|
|
|
/**
|
|
|
|
* @brief SSP CPSR initialization data.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
uint32_t cpsr;
|
2009-12-19 11:10:08 +00:00
|
|
|
} SPIConfig;
|
|
|
|
|
|
|
|
/**
|
2010-10-04 17:16:18 +00:00
|
|
|
* @brief Structure representing a SPI driver.
|
2009-12-19 11:10:08 +00:00
|
|
|
*/
|
2010-10-17 09:13:43 +00:00
|
|
|
struct SPIDriver {
|
2009-12-19 11:10:08 +00:00
|
|
|
/**
|
2010-02-21 07:24:53 +00:00
|
|
|
* @brief Driver state.
|
2009-12-19 11:10:08 +00:00
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
spistate_t state;
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
|
|
|
* @brief Current configuration data.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
const SPIConfig *config;
|
2010-10-17 09:13:43 +00:00
|
|
|
#if SPI_USE_WAIT || defined(__DOXYGEN__)
|
|
|
|
/**
|
|
|
|
* @brief Waiting thread.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
Thread *thread;
|
2010-10-17 09:13:43 +00:00
|
|
|
#endif /* SPI_USE_WAIT */
|
2009-12-19 11:10:08 +00:00
|
|
|
#if SPI_USE_MUTUAL_EXCLUSION || defined(__DOXYGEN__)
|
|
|
|
#if CH_USE_MUTEXES || defined(__DOXYGEN__)
|
|
|
|
/**
|
|
|
|
* @brief Mutex protecting the bus.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
Mutex mutex;
|
2009-12-19 11:10:08 +00:00
|
|
|
#elif CH_USE_SEMAPHORES
|
2011-03-08 10:09:57 +00:00
|
|
|
Semaphore semaphore;
|
2009-12-19 11:10:08 +00:00
|
|
|
#endif
|
|
|
|
#endif /* SPI_USE_MUTUAL_EXCLUSION */
|
2010-10-17 09:13:43 +00:00
|
|
|
#if defined(SPI_DRIVER_EXT_FIELDS)
|
|
|
|
SPI_DRIVER_EXT_FIELDS
|
|
|
|
#endif
|
|
|
|
/* End of the mandatory fields.*/
|
2009-12-19 11:10:08 +00:00
|
|
|
/**
|
2010-10-17 09:13:43 +00:00
|
|
|
* @brief Pointer to the SSP registers block.
|
2009-12-19 11:10:08 +00:00
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
SSP *ssp;
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
2011-03-18 18:38:08 +00:00
|
|
|
* @brief Number of bytes yet to be received.
|
2010-10-17 09:13:43 +00:00
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
uint32_t rxcnt;
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
|
|
|
* @brief Receive pointer or @p NULL.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
void *rxptr;
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
|
|
|
* @brief Number of bytes yet to be transmitted.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
uint32_t txcnt;
|
2010-10-17 09:13:43 +00:00
|
|
|
/**
|
|
|
|
* @brief Transmit pointer or @p NULL.
|
|
|
|
*/
|
2011-03-08 10:09:57 +00:00
|
|
|
const void *txptr;
|
2010-10-17 09:13:43 +00:00
|
|
|
};
|
2009-12-19 11:10:08 +00:00
|
|
|
|
2009-12-29 12:05:35 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* Driver macros. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2009-12-19 11:10:08 +00:00
|
|
|
/*===========================================================================*/
|
|
|
|
/* External declarations. */
|
|
|
|
/*===========================================================================*/
|
|
|
|
|
2010-10-17 09:13:43 +00:00
|
|
|
#if LPC214x_SPI_USE_SSP && !defined(__DOXYGEN__)
|
2009-12-19 11:10:08 +00:00
|
|
|
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);
|
2010-10-30 11:18:28 +00:00
|
|
|
uint16_t spi_lld_polled_exchange(SPIDriver *spip, uint16_t frame);
|
2009-12-19 11:10:08 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
|
2010-11-01 17:29:56 +00:00
|
|
|
#endif /* HAL_USE_SPI */
|
2009-12-19 11:10:08 +00:00
|
|
|
|
|
|
|
#endif /* _SPI_LLD_H_ */
|
|
|
|
|
|
|
|
/** @} */
|