pwm.h

Go to the documentation of this file.

/*
 * This file is part of the Ultibo project, https://ultibo.org/
 *
 * The MIT License (MIT)
 *
 * Copyright (c) 2026 Garry Wood <garry@softoz.com.au>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#ifndef _ULTIBO_PWM_H
#define _ULTIBO_PWM_H
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include "ultibo/globaltypes.h"
#include "ultibo/globalconst.h"
#include "ultibo/devices.h"

#define PWM_NAME_PREFIX "PWM" 

#define PWM_TYPE_NONE   0
 
#define PWM_TYPE_MAX    0

#define PWM_STATE_DISABLED  0
#define PWM_STATE_ENABLED   1
 
#define PWM_STATE_MAX   1

#define PWM_FLAG_NONE   0x00000000
#define PWM_FLAG_GPIO   0x00000001 
#define PWM_FLAG_MODE   0x00000002 
#define PWM_FLAG_RANGE  0x00000004 
#define PWM_FLAG_FREQUENCY  0x00000008 
#define PWM_FLAG_POLARITY   0x00000010 

#define PWM_MODE_MARKSPACE  0 
#define PWM_MODE_BALANCED   1 
#define PWM_MODE_SERIALIZED 2 
 
#define PWM_MODE_MAX    2

#define PWM_POLARITY_NORMAL 0
#define PWM_POLARITY_INVERSE    1
 
#define PWM_POLARITY_MAX    1


typedef struct _PWM_PROPERTIES PWM_PROPERTIES;
struct _PWM_PROPERTIES
{
    uint32_t flags; 
    uint32_t gpio;
    uint32_t mode;
    uint32_t range;
    uint32_t frequency;
    uint32_t polarity;
    uint32_t dutyns;
    uint32_t periodns;
    uint32_t minperiod;
};

typedef struct _PWM_DEVICE PWM_DEVICE;

typedef uint32_t STDCALL (*pwm_enumerate_cb)(PWM_DEVICE *pwm, void *data);
typedef uint32_t STDCALL (*pwm_notification_cb)(DEVICE *device, void *data, uint32_t notification);

typedef uint32_t STDCALL (*pwm_device_start_proc)(PWM_DEVICE *pwm);
typedef uint32_t STDCALL (*pwm_device_stop_proc)(PWM_DEVICE *pwm);
 
typedef uint32_t STDCALL (*pwm_device_write_proc)(PWM_DEVICE *pwm, uint32_t value);
 
typedef uint32_t STDCALL (*pwm_device_get_gpio_proc)(PWM_DEVICE *pwm);
typedef uint32_t STDCALL (*pwm_device_set_gpio_proc)(PWM_DEVICE *pwm, uint32_t gpio);
typedef uint32_t STDCALL (*pwm_device_get_mode_proc)(PWM_DEVICE *pwm);
typedef uint32_t STDCALL (*pwm_device_set_mode_proc)(PWM_DEVICE *pwm, uint32_t mode);
typedef uint32_t STDCALL (*pwm_device_get_range_proc)(PWM_DEVICE *pwm);
typedef uint32_t STDCALL (*pwm_device_set_range_proc)(PWM_DEVICE *pwm, uint32_t range);
typedef uint32_t STDCALL (*pwm_device_get_frequency_proc)(PWM_DEVICE *pwm);
typedef uint32_t STDCALL (*pwm_device_set_frequency_proc)(PWM_DEVICE *pwm, uint32_t frequency);
typedef uint32_t STDCALL (*pwm_device_get_polarity_proc)(PWM_DEVICE *pwm);
typedef uint32_t STDCALL (*pwm_device_set_polarity_proc)(PWM_DEVICE *pwm, uint32_t polarity);
 
typedef uint32_t STDCALL (*pwm_device_configure_proc)(PWM_DEVICE *pwm, uint32_t dutyns, uint32_t periodns);
 
typedef uint32_t STDCALL (*pwm_device_get_properties_proc)(PWM_DEVICE *pwm, PWM_PROPERTIES *properties);
 
struct _PWM_DEVICE
{
    // Device Properties
    DEVICE device; 
    // PWM Properties
    uint32_t pwmid; 
    uint32_t pwmstate; 
    pwm_device_start_proc devicestart; 
    pwm_device_stop_proc devicestop; 
    pwm_device_write_proc devicewrite; 
    pwm_device_get_gpio_proc devicegetgpio; 
    pwm_device_set_gpio_proc devicesetgpio; 
    pwm_device_get_mode_proc devicegetmode; 
    pwm_device_set_mode_proc devicesetmode; 
    pwm_device_get_range_proc devicegetrange; 
    pwm_device_set_range_proc devicesetrange; 
    pwm_device_get_frequency_proc devicegetfrequency; 
    pwm_device_set_frequency_proc devicesetfrequency; 
    pwm_device_get_polarity_proc devicegetpolarity; 
    pwm_device_set_polarity_proc devicesetpolarity; 
    pwm_device_configure_proc deviceconfigure; 
    pwm_device_get_properties_proc devicegetproperties; 
    // Statistics Properties
    uint32_t getcount;
    uint32_t setcount;
    uint32_t writecount;
    uint32_t configcount;
    // Driver Properties
    MUTEX_HANDLE lock; 
    uint32_t gpio; 
    uint32_t mode; 
    uint32_t range; 
    uint32_t frequency; 
    uint32_t polarity; 
    uint32_t dutyns; 
    uint32_t periodns; 
    PWM_PROPERTIES properties; 
    // Internal Properties
    PWM_DEVICE *prev; 
    PWM_DEVICE *next; 
};


uint32_t STDCALL pwm_device_start(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_stop(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_write(PWM_DEVICE *pwm, uint32_t value);

uint32_t STDCALL pwm_device_get_gpio(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_set_gpio(PWM_DEVICE *pwm, uint32_t gpio);

uint32_t STDCALL pwm_device_get_mode(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_set_mode(PWM_DEVICE *pwm, uint32_t mode);

uint32_t STDCALL pwm_device_get_range(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_set_range(PWM_DEVICE *pwm, uint32_t range);

uint32_t STDCALL pwm_device_get_frequency(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_set_frequency(PWM_DEVICE *pwm, uint32_t frequency);

uint32_t STDCALL pwm_device_get_polarity(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_set_polarity(PWM_DEVICE *pwm, uint32_t polarity);

uint32_t STDCALL pwm_device_configure(PWM_DEVICE *pwm, uint32_t dutyns, uint32_t periodns);

uint32_t STDCALL pwm_device_properties(PWM_DEVICE *pwm, PWM_PROPERTIES *properties);

uint32_t STDCALL pwm_device_get_properties(PWM_DEVICE *pwm, PWM_PROPERTIES *properties);

PWM_DEVICE * STDCALL pwm_device_create(void);

PWM_DEVICE * STDCALL pwm_device_create_ex(uint32_t size);

uint32_t STDCALL pwm_device_destroy(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_register(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_device_deregister(PWM_DEVICE *pwm);
 
PWM_DEVICE * STDCALL pwm_device_find(uint32_t pwmid);
PWM_DEVICE * STDCALL pwm_device_find_by_name(const char *name);
PWM_DEVICE * STDCALL pwm_device_find_by_description(const char *description);
uint32_t STDCALL pwm_device_enumerate(pwm_enumerate_cb callback, void *data);
 
uint32_t STDCALL pwm_device_notification(PWM_DEVICE *pwm, pwm_notification_cb callback, void *data, uint32_t notification, uint32_t flags);


uint32_t STDCALL pwm_get_count(void);

PWM_DEVICE * STDCALL pwm_device_get_default(void);

uint32_t STDCALL pwm_device_set_default(PWM_DEVICE *pwm);

PWM_DEVICE * STDCALL pwm_device_check(PWM_DEVICE *pwm);

uint32_t STDCALL pwm_type_to_string(uint32_t pwmtype, char *string, uint32_t len);

uint32_t STDCALL pwm_state_to_string(uint32_t pwmstate, char *string, uint32_t len);

uint32_t STDCALL pwm_mode_to_string(uint32_t pwmmode, char *string, uint32_t len);

uint32_t STDCALL pwm_polarity_to_string(uint32_t pwmpolarity, char *string, uint32_t len);
 
#ifdef __cplusplus
}
#endif
 
#endif // _ULTIBO_PWM_H