sol-gpio.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 <stdbool.h>
#include <stdint.h>
#include <sol-common-buildopts.h>
#include <sol-macros.h>

#ifdef __cplusplus
extern "C" {
#endif

struct sol_gpio;
typedef struct sol_gpio sol_gpio;

enum sol_gpio_direction {
    SOL_GPIO_DIR_OUT = 0,
    SOL_GPIO_DIR_IN = 1
};

enum sol_gpio_edge {
    SOL_GPIO_EDGE_NONE = 0,
    SOL_GPIO_EDGE_RISING,
    SOL_GPIO_EDGE_FALLING,
    SOL_GPIO_EDGE_BOTH
};

enum sol_gpio_drive {
    SOL_GPIO_DRIVE_NONE = 0,
    SOL_GPIO_DRIVE_PULL_UP,
    SOL_GPIO_DRIVE_PULL_DOWN
};

typedef struct sol_gpio_config {
#ifndef SOL_NO_API_VERSION
#define SOL_GPIO_CONFIG_API_VERSION (1)
    uint16_t api_version; 
#endif

    enum sol_gpio_direction dir;
    bool active_low;
    enum sol_gpio_drive drive_mode;
    union {
        struct {
            enum sol_gpio_edge trigger_mode;
            void (*cb)(void *data, struct sol_gpio *gpio, bool value);
            const void *user_data;
            uint32_t poll_timeout;
        } in;
        struct {
            bool value;
        } out;
    };
} sol_gpio_config;

enum sol_gpio_direction sol_gpio_direction_from_str(const char *direction)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_gpio_direction_to_str(enum sol_gpio_direction direction)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

enum sol_gpio_edge sol_gpio_edge_from_str(const char *edge)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_gpio_edge_to_str(enum sol_gpio_edge edge)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

enum sol_gpio_drive sol_gpio_drive_from_str(const char *drive)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_gpio_drive_to_str(enum sol_gpio_drive drive)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

struct sol_gpio *sol_gpio_open_by_label(const char *label, const struct sol_gpio_config *config)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

struct sol_gpio *sol_gpio_open(uint32_t pin, const struct sol_gpio_config *config)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;


struct sol_gpio *sol_gpio_open_raw(uint32_t pin, const struct sol_gpio_config *config)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

void sol_gpio_close(struct sol_gpio *gpio);

bool sol_gpio_write(struct sol_gpio *gpio, bool value);

int sol_gpio_read(struct sol_gpio *gpio);

#ifdef __cplusplus
}
#endif