sol-pwm.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_pwm;
typedef struct sol_pwm sol_pwm;

enum sol_pwm_alignment {
    SOL_PWM_ALIGNMENT_LEFT, 
    SOL_PWM_ALIGNMENT_RIGHT, 
    SOL_PWM_ALIGNMENT_CENTER 
};

enum sol_pwm_polarity {
    SOL_PWM_POLARITY_NORMAL,
    SOL_PWM_POLARITY_INVERSED
};

typedef struct sol_pwm_config {
#ifndef SOL_NO_API_VERSION
#define SOL_PWM_CONFIG_API_VERSION (1)
    uint16_t api_version; 
#endif
    int32_t period_ns; 
    int32_t duty_cycle_ns; 
    enum sol_pwm_alignment alignment; 
    enum sol_pwm_polarity polarity; 
    bool enabled; 
} sol_pwm_config;

enum sol_pwm_alignment sol_pwm_alignment_from_str(const char *pwm_alignment)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_pwm_alignment_to_str(enum sol_pwm_alignment pwm_alignment)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

enum sol_pwm_polarity sol_pwm_polarity_from_str(const char *pwm_polarity)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

const char *sol_pwm_polarity_to_str(enum sol_pwm_polarity pwm_polarity)
#ifndef DOXYGEN_RUN
    SOL_ATTR_WARN_UNUSED_RESULT
#endif
    ;

struct sol_pwm *sol_pwm_open_by_label(const char *label, const struct sol_pwm_config *config);

struct sol_pwm *sol_pwm_open(int device, int channel, const struct sol_pwm_config *config);

struct sol_pwm *sol_pwm_open_raw(int device, int channel, const struct sol_pwm_config *config);

void sol_pwm_close(struct sol_pwm *pwm);

int sol_pwm_set_enabled(struct sol_pwm *pwm, bool enable);

bool sol_pwm_is_enabled(const struct sol_pwm *pwm);

int sol_pwm_set_period(struct sol_pwm *pwm, uint32_t period_ns);

int32_t sol_pwm_get_period(const struct sol_pwm *pwm);

int sol_pwm_set_duty_cycle(struct sol_pwm *pwm, uint32_t duty_cycle_ns);

int32_t sol_pwm_get_duty_cycle(const struct sol_pwm *pwm);

#ifdef __cplusplus
}
#endif