libmygpio_gpio_struct.h

Go to the documentation of this file.

/*
 SPDX-License-Identifier: GPL-3.0-or-later
 libmygpio (c) 2020-2026 Juergen Mang <mail@jcgames.de>
 https://github.com/jcorporation/mympd
*/

 
#ifndef LIBMYGPIO_GPIO_STRUCT_H
#define LIBMYGPIO_GPIO_STRUCT_H
 
#include <stdbool.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct t_mygpio_connection;

struct t_mygpio_gpio;


enum mygpio_gpio_direction {
    MYGPIO_GPIO_DIRECTION_UNKNOWN = -1,  
    MYGPIO_GPIO_DIRECTION_IN,            
    MYGPIO_GPIO_DIRECTION_OUT            
};

enum mygpio_gpio_value {
    MYGPIO_GPIO_VALUE_UNKNOWN = -1,  
    MYGPIO_GPIO_VALUE_INACTIVE,      
    MYGPIO_GPIO_VALUE_ACTIVE         
};

enum mygpio_gpio_bias {
    MYGPIO_BIAS_UNKNOWN = -1,  
    MYGPIO_BIAS_AS_IS,         
    MYGPIO_BIAS_DISABLED,      
    MYGPIO_BIAS_PULL_DOWN,     
    MYGPIO_BIAS_PULL_UP        
};

enum mygpio_event_request {
    MYGPIO_EVENT_REQUEST_UNKNOWN = -1,  
    MYGPIO_EVENT_REQUEST_FALLING,       
    MYGPIO_EVENT_REQUEST_RISING,        
    MYGPIO_EVENT_REQUEST_BOTH           
};

enum mygpio_event_clock {
    MYGPIO_EVENT_CLOCK_UNKNOWN = -1,  
    MYGPIO_EVENT_CLOCK_MONOTONIC,     
    MYGPIO_EVENT_CLOCK_REALTIME,      
    MYGPIO_EVENT_CLOCK_HTE            
};

enum mygpio_drive {
    MYGPIO_DRIVE_UNKNOWN = -1,  
    MYGPIO_DRIVE_PUSH_PULL,     
    MYGPIO_DRIVE_OPEN_DRAIN,    
    MYGPIO_DRIVE_OPEN_SOURCE    
};

unsigned mygpio_gpio_get_gpio(struct t_mygpio_gpio *gpio);

enum mygpio_gpio_direction mygpio_gpio_get_direction(struct t_mygpio_gpio *gpio);

enum mygpio_gpio_value mygpio_gpio_get_value(struct t_mygpio_gpio *gpio);

bool mygpio_gpio_in_get_active_low(struct t_mygpio_gpio *gpio);

enum mygpio_gpio_bias mygpio_gpio_in_get_bias(struct t_mygpio_gpio *gpio);

enum mygpio_event_request mygpio_gpio_in_get_event_request(struct t_mygpio_gpio *gpio);

bool mygpio_gpio_in_get_is_debounced(struct t_mygpio_gpio *gpio);

int mygpio_gpio_in_get_debounce_period_us(struct t_mygpio_gpio *gpio);

enum mygpio_event_clock mygpio_gpio_in_get_event_clock(struct t_mygpio_gpio *gpio);

enum mygpio_drive mygpio_gpio_out_get_drive(struct t_mygpio_gpio *gpio);

const char *mygpio_gpio_get_name(struct t_mygpio_gpio *gpio);

void mygpio_free_gpio(struct t_mygpio_gpio *gpio);

 
#ifdef __cplusplus
}
#endif
 
#endif