mraa  0.7.1
Low Level Skeleton Library for Communication on GNU/Linux platforms
spi.hpp
1 /*
2  * Author: Brendan Le Foll <brendan.le.foll@intel.com>
3  * Copyright (c) 2014 Intel Corporation.
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining
6  * a copy of this software and associated documentation files (the
7  * "Software"), to deal in the Software without restriction, including
8  * without limitation the rights to use, copy, modify, merge, publish,
9  * distribute, sublicense, and/or sell copies of the Software, and to
10  * permit persons to whom the Software is furnished to do so, subject to
11  * the following conditions:
12  *
13  * The above copyright notice and this permission notice shall be
14  * included in all copies or substantial portions of the Software.
15  *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20  * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21  * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22  * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23  */
24 
25 #pragma once
26 
27 #include "spi.h"
28 #include <stdexcept>
29 
30 namespace mraa
31 {
32 
36 typedef enum {
37  SPI_MODE0 = 0,
39  SPI_MODE1 = 1,
41  SPI_MODE2 = 2,
43  SPI_MODE3 = 3,
45 } Spi_Mode;
46 
47 
55 class Spi
56 {
57  public:
63  Spi(int bus)
64  {
65  m_spi = mraa_spi_init(bus);
66 
67  if (m_spi == NULL) {
68  throw std::invalid_argument("Error initialising SPI bus");
69  }
70  }
71 
75  ~Spi()
76  {
77  mraa_spi_stop(m_spi);
78  }
79 
88  {
89  return mraa_spi_mode(m_spi, (mraa_spi_mode_t) mode);
90  }
91 
99  frequency(int hz)
100  {
101  return mraa_spi_frequency(m_spi, hz);
102  }
103 
110  int
111  writeByte(uint8_t data)
112  {
113  return mraa_spi_write(m_spi, (uint8_t) data);
114  }
115 
122  uint16_t
123  write_word(uint16_t data)
124  {
125  return mraa_spi_write_word(m_spi, (uint16_t) data);
126  }
127 
137  uint8_t*
138  write(uint8_t* txBuf, int length)
139  {
140  return mraa_spi_write_buf(m_spi, txBuf, length);
141  }
142 
143 #ifndef SWIG
144 
153  uint16_t*
154  write_word(uint16_t* txBuf, int length)
155  {
156  return mraa_spi_write_buf_word(m_spi, txBuf, length);
157  }
158 #endif
159 
160 #ifndef SWIG
161 
171  transfer(uint8_t* txBuf, uint8_t* rxBuf, int length)
172  {
173  return mraa_spi_transfer_buf(m_spi, txBuf, rxBuf, length);
174  }
175 
186  transfer_word(uint16_t* txBuf, uint16_t* rxBuf, int length)
187  {
188  return mraa_spi_transfer_buf_word(m_spi, txBuf, rxBuf, length);
189  }
190 #endif
191 
199  lsbmode(bool lsb)
200  {
201  return mraa_spi_lsbmode(m_spi, (mraa_boolean_t) lsb);
202  }
203 
211  bitPerWord(unsigned int bits)
212  {
213  return mraa_spi_bit_per_word(m_spi, bits);
214  }
215 
216  private:
217  mraa_spi_context m_spi;
218 };
219 }
unsigned int mraa_boolean_t
Definition: common.h:45
Definition: spi.hpp:39
mraa_result_t frequency(int hz)
Definition: spi.hpp:99
mraa_result_t mraa_spi_lsbmode(mraa_spi_context dev, mraa_boolean_t lsb)
mraa_result_t mraa_spi_frequency(mraa_spi_context dev, int hz)
mraa_result_t mraa_spi_bit_per_word(mraa_spi_context dev, unsigned int bits)
Definition: spi.hpp:37
struct _spi * mraa_spi_context
Definition: spi.h:67
Serial Peripheral Interface.
mraa_result_t transfer_word(uint16_t *txBuf, uint16_t *rxBuf, int length)
Definition: spi.hpp:186
uint16_t write_word(uint16_t data)
Definition: spi.hpp:123
uint8_t * write(uint8_t *txBuf, int length)
Definition: spi.hpp:138
mraa_result_t mraa_spi_stop(mraa_spi_context dev)
mraa_result_t transfer(uint8_t *txBuf, uint8_t *rxBuf, int length)
Definition: spi.hpp:171
mraa_result_t mode(Spi_Mode mode)
Definition: spi.hpp:87
int mraa_spi_write(mraa_spi_context dev, uint8_t data)
mraa_spi_mode_t
Definition: spi.h:53
int writeByte(uint8_t data)
Definition: spi.hpp:111
uint16_t * write_word(uint16_t *txBuf, int length)
Definition: spi.hpp:154
mraa_result_t bitPerWord(unsigned int bits)
Definition: spi.hpp:211
Spi(int bus)
Definition: spi.hpp:63
mraa_result_t lsbmode(bool lsb)
Definition: spi.hpp:199
mraa_result_t mraa_spi_transfer_buf(mraa_spi_context dev, uint8_t *data, uint8_t *rxbuf, int length)
Definition: spi.hpp:41
mraa_spi_context mraa_spi_init(int bus)
Definition: aio.hpp:30
uint16_t mraa_spi_write_word(mraa_spi_context dev, uint16_t data)
mraa_result_t
Definition: types.h:184
Definition: spi.hpp:43
Spi_Mode
Definition: spi.hpp:36
uint8_t * mraa_spi_write_buf(mraa_spi_context dev, uint8_t *data, int length)
mraa_result_t mraa_spi_mode(mraa_spi_context dev, mraa_spi_mode_t mode)
API to Serial Peripheral Interface.
Definition: spi.hpp:55
uint16_t * mraa_spi_write_buf_word(mraa_spi_context dev, uint16_t *data, int length)
mraa_result_t mraa_spi_transfer_buf_word(mraa_spi_context dev, uint16_t *data, uint16_t *rxbuf, int length)
~Spi()
Definition: spi.hpp:75