sol-iio.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 <sol-buffer.h>
#include <sol-common-buildopts.h>

#include <linux/limits.h>

#ifdef __cplusplus
extern "C" {
#endif

struct sol_iio_device;
typedef struct sol_iio_device sol_iio_device;

struct sol_iio_channel;
typedef struct sol_iio_channel sol_iio_channel;

typedef struct sol_iio_config {
#ifndef SOL_NO_API_VERSION
#define SOL_IIO_CONFIG_API_VERSION (2)
    uint16_t api_version; 
#endif
    const char *trigger_name; 
    void (*sol_iio_reader_cb)(void *data, struct sol_iio_device *device); 
    const void *data; 
    int buffer_size; 
    int sampling_frequency; 
    char sampling_frequency_name[NAME_MAX]; 
} sol_iio_config;

typedef struct sol_iio_channel_config {
#ifndef SOL_NO_API_VERSION
#define SOL_IIO_CHANNEL_CONFIG_API_VERSION (1)
    uint16_t api_version; 
#endif
    double scale; 
    int offset; 
    bool use_custom_offset; 
} sol_iio_channel_config;

#define SOL_IIO_CHANNEL_CONFIG_INIT { \
        SOL_SET_API_VERSION(.api_version = SOL_IIO_CHANNEL_CONFIG_API_VERSION, ) \
        .scale = -1.0, .offset = 0, .use_custom_offset = false }

struct sol_iio_device *sol_iio_open(int id, const struct sol_iio_config *config);

void sol_iio_close(struct sol_iio_device *device);

struct sol_iio_channel *sol_iio_add_channel(struct sol_iio_device *device, const char *name, const struct sol_iio_channel_config *config);

int sol_iio_read_channel_value(struct sol_iio_channel *channel, double *value);

int sol_iio_device_trigger(struct sol_iio_device *device);

int sol_iio_device_start_buffer(struct sol_iio_device *device);

int sol_iio_address_device(const char *commands);

struct sol_str_slice
sol_iio_read_channel_raw_buffer(struct sol_iio_channel *channel);

int
sol_iio_mount_calibration(struct sol_iio_device *device, sol_direction_vector *value);

const char *sol_iio_channel_get_name(const struct sol_iio_channel *channel);


int sol_iio_device_get_scale(const struct sol_iio_device *device, const char *prefix_name, double *scale);

int sol_iio_device_get_offset(const struct sol_iio_device *device, const char *prefix_name, double *offset);

int sol_iio_device_get_sampling_frequency(const struct sol_iio_device *device, const char *prefix_name, int *sampling_frequency);

#ifdef __cplusplus
}
#endif