api/maa/spi.h

   1 /*
   2  * Author: Thomas Ingleby <thomas.c.ingleby@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 /**
  28  * @file
  29  * @brief System Packet Interface
  30  *
  31  * This file defines the spi interface for libmaa
  32  *
  33  * @snippet spi_mcp4261.c Interesting
  34  */
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 #include <stdio.h>
  41 #include <fcntl.h>
  42 #include <stdint.h>
  43
  44 #include "common.h"
  45
  46 /**
  47  * Opaque pointer definition to the internal struct _spi
  48  */
  49 typedef struct _spi* maa_spi_context;
  50
  51 /**
  52  * Initialise SPI_context, uses board mapping. Sets the muxes
  53  *
  54  * @param bus Bus to use, as listed in platform definition, normally 0
  55  * @return Spi context or NULL
  56  */
  57 maa_spi_context maa_spi_init(int bus);
  58
  59 /**
  60  * Set the SPI device mode. see spidev 0-3.
  61  *
  62  * @param dev The Spi context
  63  * @param mode The SPI mode, See Linux spidev
  64  * @return Spi context or NULL
  65  */
  66 maa_result_t maa_spi_mode(maa_spi_context dev,unsigned short mode);
  67
  68 /** Set the SPI device operating clock frequency.
  69  *
  70  * @param dev the Spi context
  71  * @param hz the frequency in hz
  72  * @return maa_spi_context The returned initialised SPI context
  73  */
  74 maa_result_t maa_spi_frequency(maa_spi_context dev, int hz);
  75
  76 /** Write Single Byte to the SPI device.
  77  *
  78  * @param dev The Spi context
  79  * @param data Data to send
  80  * @return Data received on the miso line
  81  */
  82 uint8_t maa_spi_write(maa_spi_context dev, uint8_t data);
  83
  84 /** Write Buffer of bytes to the SPI device. The pointer return has to be
  85  * free'd by the caller.
  86  *
  87  * @param dev The Spi context
  88  * @param data to send
  89  * @param length elements within buffer, Max 4096
  90  * @return Data received on the miso line, same length as passed in
  91  */
  92 uint8_t* maa_spi_write_buf(maa_spi_context dev, uint8_t* data, int length);
  93
  94 /**
  95  * Change the SPI lsb mode
  96  *
  97  * @param dev The Spi context
  98  * @param lsb Use least significant bit transmission. 0 for msbi
  99  * @return Result of operation
 100  */
 101 maa_result_t maa_spi_lsbmode(maa_spi_context dev, maa_boolean_t lsb);
 102
 103 /**
 104  * Set bits per mode on transaction, defaults at 8
 105  *
 106  * @param dev The Spi context
 107  * @param bits bits per word
 108  * @return Result of operation
 109  */
 110 maa_result_t maa_spi_bit_per_word(maa_spi_context dev, unsigned int bits);
 111
 112 /**
 113  * De-inits an maa_spi_context device
 114  *
 115  * @param dev The Spi context
 116  * @return Result of operation
 117  */
 118 maa_result_t maa_spi_stop(maa_spi_context dev);
 119
 120 #ifdef __cplusplus
 121 }
 122 #endif