core/ssp/ssp.h

   1 /**************************************************************************/
   2 /*!
   3     @file     ssp.h
   4     @author   K. Townsend (microBuilder.eu)
   5     @date     22 March 2010
   6     @version  0.10
   7
   8     @section LICENSE
   9
  10     Software License Agreement (BSD License)
  11
  12     Copyright (c) 2010, microBuilder SARL
  13     All rights reserved.
  14
  15     Redistribution and use in source and binary forms, with or without
  16     modification, are permitted provided that the following conditions are met:
  17     1. Redistributions of source code must retain the above copyright
  18     notice, this list of conditions and the following disclaimer.
  19     2. Redistributions in binary form must reproduce the above copyright
  20     notice, this list of conditions and the following disclaimer in the
  21     documentation and/or other materials provided with the distribution.
  22     3. Neither the name of the copyright holders nor the
  23     names of its contributors may be used to endorse or promote products
  24     derived from this software without specific prior written permission.
  25
  26     THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ''AS IS'' AND ANY
  27     EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  28     WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  29     DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE FOR ANY
  30     DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  31     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  32     LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  33     ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  34     (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  35     SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  36 */
  37 /**************************************************************************/
  38
  39 #ifndef _SSP_H_
  40 #define _SSP_H_
  41
  42 #include "projectconfig.h"
  43 #include "core/gpio/gpio.h"
  44
  45 #define SSP_FIFOSIZE            8       /* SPI read and write buffer size */
  46 #define SSP_MAX_TIMEOUT         0xFF
  47
  48 #define SSP0_CSPORT             0
  49 #define SSP0_CSPIN              2
  50
  51 /* Macro definitions to enable and disable SPI */
  52 #define ssp0Select()            do {gpioSetValue(SSP0_CSPORT, SSP0_CSPIN, 0);} while (0)
  53 #define ssp0Deselect()          do {gpioSetValue(SSP0_CSPORT, SSP0_CSPIN, 1);} while (0)
  54
  55 /**************************************************************************/
  56 /*!
  57     Indicates whether the clock should be high or low between frames.
  58 */
  59 /**************************************************************************/
  60 typedef enum sspClockPolarity_e
  61 {
  62   sspClockPolarity_Low = 0,
  63   sspClockPolarity_High
  64 }
  65 sspClockPolarity_t;
  66
  67 /**************************************************************************/
  68 /*!
  69     Indicates whether the bits start at the rising or falling edge of
  70     the clock transition.
  71 */
  72 /**************************************************************************/
  73 typedef enum sspClockPhase_e
  74 {
  75   sspClockPhase_RisingEdge = 0,
  76   sspClockPhase_FallingEdge
  77 }
  78 sspClockPhase_t;
  79
  80 extern void SSP_IRQHandler (void);
  81 void sspInit (uint8_t portNum, sspClockPolarity_t polarity, sspClockPhase_t phase);
  82 void sspSend (uint8_t portNum, uint8_t *buf, uint32_t length);
  83 void sspReceive (uint8_t portNum, uint8_t *buf, uint32_t length);
  84
  85 #endif