sol-spi.h

Go to the documentation of this file.

/*
 * This file is part of the Soletta (TM) Project
 *
 * Copyright (C) 2015 Intel Corporation. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <stdint.h>
#include <stdbool.h>

#include <sol-common-buildopts.h>
#include <sol-macros.h>

#ifdef __cplusplus
extern "C" {
#endif

struct sol_spi;
typedef struct sol_spi sol_spi;

enum sol_spi_mode {
    SOL_SPI_MODE_0 = 0, 
    SOL_SPI_MODE_1, 
    SOL_SPI_MODE_2, 
    SOL_SPI_MODE_3 
};

#define SOL_SPI_DATA_BITS_DEFAULT 8

typedef struct sol_spi_config {
#ifndef SOL_NO_API_VERSION
#define SOL_SPI_CONFIG_API_VERSION (1)
    uint16_t api_version; 
#endif
    unsigned int chip_select; 
    enum sol_spi_mode mode; 
    uint32_t frequency; 
    uint8_t bits_per_word; 
} sol_spi_config;

enum sol_spi_mode sol_spi_mode_from_str(const char *spi_mode)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_spi_mode_to_str(enum sol_spi_mode spi_mode)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

int sol_spi_transfer(struct sol_spi *spi, const uint8_t *tx, uint8_t *rx, size_t count, void (*transfer_cb)(void *cb_data, struct sol_spi *spi, const uint8_t *tx, uint8_t *rx, ssize_t status), const void *cb_data);

void sol_spi_close(struct sol_spi *spi);

struct sol_spi *sol_spi_open(unsigned int bus, const struct sol_spi_config *config);

#ifdef __cplusplus
}
#endif