bertos/cpu/cortex-m3/drv/ssi_lm3s.h

   1 /**
   2  * \file
   3  * <!--
   4  * This file is part of BeRTOS.
   5  *
   6  * Bertos is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  19  *
  20  * As a special exception, you may use this file as part of a free software
  21  * library without restriction.  Specifically, if other files instantiate
  22  * templates or use macros or inline functions from this file, or you compile
  23  * this file and link it with other files to produce an executable, this
  24  * file does not by itself cause the resulting executable to be covered by
  25  * the GNU General Public License.  This exception does not however
  26  * invalidate any other reasons why the executable file might be covered by
  27  * the GNU General Public License.
  28  *
  29  * Copyright 2010 Develer S.r.l. (http://www.develer.com/)
  30  *
  31  * -->
  32  *
  33  * \brief LM3S1968 Synchronous Serial Interface (SSI) driver.
  34  */
  35
  36 #ifndef SSI_LM3S_H
  37 #define SSI_LM3S_H
  38
  39 #include <cpu/power.h> /* cpu_relax() */
  40
  41 /**
  42  * LM3S1968 SSI frame format
  43  */
  44 /*\{*/
  45 #define SSI_FRF_MOTO_MODE_0     0x00000000  //< Moto fmt, polarity 0, phase 0
  46 #define SSI_FRF_MOTO_MODE_1     0x00000002  //< Moto fmt, polarity 0, phase 1
  47 #define SSI_FRF_MOTO_MODE_2     0x00000001  //< Moto fmt, polarity 1, phase 0
  48 #define SSI_FRF_MOTO_MODE_3     0x00000003  //< Moto fmt, polarity 1, phase 1
  49 #define SSI_FRF_TI              0x00000010  //< TI frame format
  50 #define SSI_FRF_NMW             0x00000020  //< National MicroWire frame format
  51 /*\}*/
  52
  53 /**
  54  * LM3S1968 SSI operational mode
  55  */
  56 /*\{*/
  57 #define SSI_MODE_MASTER         0x00000000  //< SSI master
  58 #define SSI_MODE_SLAVE          0x00000001  //< SSI slave
  59 #define SSI_MODE_SLAVE_OD       0x00000002  //< SSI slave with output disabled
  60 /*\}*/
  61
  62 int lm3s_ssi_init(uint32_t base, uint32_t frame, int mode,
  63                    unsigned int bitrate, unsigned int data_width);
  64 void lm3s_ssi_enable(uint32_t base);
  65 void lm3s_ssi_disable(uint32_t base);
  66 void lm3s_ssi_write_frame(uint32_t base, uint32_t val);
  67 int lm3s_ssi_write_frame_nonblocking(uint32_t base, uint32_t val);
  68 void lm3s_ssi_read_frame(uint32_t base, uint32_t *val);
  69 int lm3s_ssi_read_frame_nonblocking(uint32_t base, uint32_t *val);
  70 bool lm3s_ssi_txdone(uint32_t base);
  71
  72 INLINE void lm3s_ssi_wait_txdone(uint32_t base)
  73 {
  74         while (!lm3s_ssi_txdone(base))
  75                 cpu_relax();
  76 }
  77
  78 #endif /* SSI_LM3S_H */