Pratyush Mallick / Mbed OS testing

this is testing

app/noos_mbed/include/pwm.h@0:3afcd581558d, 2021-01-14 (annotated)

Committer:
pmallick
Date:
Thu Jan 14 18:54:16 2021 +0530
Revision:
0:3afcd581558d
this is testing

Who changed what in which revision?

UserRevisionLine numberNew contents of line
pmallick 0:3afcd581558d 1 /***************************************************************************//**
pmallick 0:3afcd581558d 2 * @file pwm.h
pmallick 0:3afcd581558d 3 * @brief Header file of PWM Interface
pmallick 0:3afcd581558d 4 * @author Cristian Pop (cristian.pop@analog.com)
pmallick 0:3afcd581558d 5 ********************************************************************************
pmallick 0:3afcd581558d 6 * Copyright 2020(c) Analog Devices, Inc.
pmallick 0:3afcd581558d 7 *
pmallick 0:3afcd581558d 8 * All rights reserved.
pmallick 0:3afcd581558d 9 *
pmallick 0:3afcd581558d 10 * Redistribution and use in source and binary forms, with or without
pmallick 0:3afcd581558d 11 * modification, are permitted provided that the following conditions are met:
pmallick 0:3afcd581558d 12 * - Redistributions of source code must retain the above copyright
pmallick 0:3afcd581558d 13 * notice, this list of conditions and the following disclaimer.
pmallick 0:3afcd581558d 14 * - Redistributions in binary form must reproduce the above copyright
pmallick 0:3afcd581558d 15 * notice, this list of conditions and the following disclaimer in
pmallick 0:3afcd581558d 16 * the documentation and/or other materials provided with the
pmallick 0:3afcd581558d 17 * distribution.
pmallick 0:3afcd581558d 18 * - Neither the name of Analog Devices, Inc. nor the names of its
pmallick 0:3afcd581558d 19 * contributors may be used to endorse or promote products derived
pmallick 0:3afcd581558d 20 * from this software without specific prior written permission.
pmallick 0:3afcd581558d 21 * - The use of this software may or may not infringe the patent rights
pmallick 0:3afcd581558d 22 * of one or more patent holders. This license does not release you
pmallick 0:3afcd581558d 23 * from the requirement that you obtain separate licenses from these
pmallick 0:3afcd581558d 24 * patent holders to use this software.
pmallick 0:3afcd581558d 25 * - Use of the software either in source or binary form, must be run
pmallick 0:3afcd581558d 26 * on or directly connected to an Analog Devices Inc. component.
pmallick 0:3afcd581558d 27 *
pmallick 0:3afcd581558d 28 * THIS SOFTWARE IS PROVIDED BY ANALOG DEVICES "AS IS" AND ANY EXPRESS OR
pmallick 0:3afcd581558d 29 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, NON-INFRINGEMENT,
pmallick 0:3afcd581558d 30 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
pmallick 0:3afcd581558d 31 * IN NO EVENT SHALL ANALOG DEVICES BE LIABLE FOR ANY DIRECT, INDIRECT,
pmallick 0:3afcd581558d 32 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
pmallick 0:3afcd581558d 33 * LIMITED TO, INTELLECTUAL PROPERTY RIGHTS, PROCUREMENT OF SUBSTITUTE GOODS OR
pmallick 0:3afcd581558d 34 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
pmallick 0:3afcd581558d 35 * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
pmallick 0:3afcd581558d 36 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
pmallick 0:3afcd581558d 37 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
pmallick 0:3afcd581558d 38 *******************************************************************************/
pmallick 0:3afcd581558d 39 #ifndef PWM_H_
pmallick 0:3afcd581558d 40 #define PWM_H_
pmallick 0:3afcd581558d 41
pmallick 0:3afcd581558d 42 /******************************************************************************/
pmallick 0:3afcd581558d 43 /***************************** Include Files **********************************/
pmallick 0:3afcd581558d 44 /******************************************************************************/
pmallick 0:3afcd581558d 45 #include <stdint.h>
pmallick 0:3afcd581558d 46 #include <stdbool.h>
pmallick 0:3afcd581558d 47
pmallick 0:3afcd581558d 48 /******************************************************************************/
pmallick 0:3afcd581558d 49 /*************************** Types Declarations *******************************/
pmallick 0:3afcd581558d 50 /******************************************************************************/
pmallick 0:3afcd581558d 51 /**
pmallick 0:3afcd581558d 52 * @enum pwm_polarity
pmallick 0:3afcd581558d 53 * @brief Possible polarities of the PWM signal
pmallick 0:3afcd581558d 54 */
pmallick 0:3afcd581558d 55 enum pwm_polarity {
pmallick 0:3afcd581558d 56 /** PWM duty cycle is high, idle low */
pmallick 0:3afcd581558d 57 PWM_POLARITY_HIGH,
pmallick 0:3afcd581558d 58 /** PWM duty cycle is low, idle high */
pmallick 0:3afcd581558d 59 PWM_POLARITY_LOW,
pmallick 0:3afcd581558d 60 };
pmallick 0:3afcd581558d 61
pmallick 0:3afcd581558d 62 /**
pmallick 0:3afcd581558d 63 * @struct pwm_init_param
pmallick 0:3afcd581558d 64 * @brief Structure containing the init parameters needed by the PWM generator
pmallick 0:3afcd581558d 65 */
pmallick 0:3afcd581558d 66 struct pwm_init_param {
pmallick 0:3afcd581558d 67 /** PWM generator period */
pmallick 0:3afcd581558d 68 uint32_t period_ns;
pmallick 0:3afcd581558d 69 /** PWM generator duty cycle */
pmallick 0:3afcd581558d 70 uint32_t duty_cycle_ns;
pmallick 0:3afcd581558d 71 /** PWM generator polarity */
pmallick 0:3afcd581558d 72 enum pwm_polarity polarity;
pmallick 0:3afcd581558d 73 /** PWM extra parameters (device specific) */
pmallick 0:3afcd581558d 74 void *extra;
pmallick 0:3afcd581558d 75 };
pmallick 0:3afcd581558d 76
pmallick 0:3afcd581558d 77 /**
pmallick 0:3afcd581558d 78 * @struct pwm_desc
pmallick 0:3afcd581558d 79 * @brief Structure representing an PWM generator device
pmallick 0:3afcd581558d 80 */
pmallick 0:3afcd581558d 81 struct pwm_desc {
pmallick 0:3afcd581558d 82 /** PWM generator period */
pmallick 0:3afcd581558d 83 uint32_t period_ns;
pmallick 0:3afcd581558d 84 /** PWM generator duty cycle */
pmallick 0:3afcd581558d 85 uint32_t duty_cycle_ns;
pmallick 0:3afcd581558d 86 /** PWM generator polarity */
pmallick 0:3afcd581558d 87 enum pwm_polarity polarity;
pmallick 0:3afcd581558d 88 /** PWM generator enabled */
pmallick 0:3afcd581558d 89 bool enabled;
pmallick 0:3afcd581558d 90 /** PWM extra parameters (device specific) */
pmallick 0:3afcd581558d 91 void *extra;
pmallick 0:3afcd581558d 92 };
pmallick 0:3afcd581558d 93
pmallick 0:3afcd581558d 94 /******************************************************************************/
pmallick 0:3afcd581558d 95 /************************ Functions Declarations ******************************/
pmallick 0:3afcd581558d 96 /******************************************************************************/
pmallick 0:3afcd581558d 97 /* Initialize the PWM generator device */
pmallick 0:3afcd581558d 98 int32_t pwm_init(struct pwm_desc **desc,
pmallick 0:3afcd581558d 99 const struct pwm_init_param *param);
pmallick 0:3afcd581558d 100
pmallick 0:3afcd581558d 101 /* Free the resources used by the PWM generator device */
pmallick 0:3afcd581558d 102 int32_t pwm_remove(struct pwm_desc *desc);
pmallick 0:3afcd581558d 103
pmallick 0:3afcd581558d 104 /* Enable PWM generator device */
pmallick 0:3afcd581558d 105 int32_t pwm_enable(struct pwm_desc *desc);
pmallick 0:3afcd581558d 106
pmallick 0:3afcd581558d 107 /* Disable PWM generator device */
pmallick 0:3afcd581558d 108 int32_t pwm_disable(struct pwm_desc *desc);
pmallick 0:3afcd581558d 109
pmallick 0:3afcd581558d 110 /* Set period of PWM generator device */
pmallick 0:3afcd581558d 111 int32_t pwm_set_period(struct pwm_desc *desc,
pmallick 0:3afcd581558d 112 uint32_t period_ns);
pmallick 0:3afcd581558d 113
pmallick 0:3afcd581558d 114 /* Get period of PWM generator device */
pmallick 0:3afcd581558d 115 int32_t pwm_get_period(struct pwm_desc *desc,
pmallick 0:3afcd581558d 116 uint32_t *period_ns);
pmallick 0:3afcd581558d 117
pmallick 0:3afcd581558d 118 /* Set duty cycle of PWM generator device */
pmallick 0:3afcd581558d 119 int32_t pwm_set_duty_cycle(struct pwm_desc *desc,
pmallick 0:3afcd581558d 120 uint32_t duty_cycle_ns);
pmallick 0:3afcd581558d 121
pmallick 0:3afcd581558d 122 /* Get period of PWM generator device */
pmallick 0:3afcd581558d 123 int32_t pwm_get_duty_cycle(struct pwm_desc *desc,
pmallick 0:3afcd581558d 124 uint32_t *duty_cycle_ns);
pmallick 0:3afcd581558d 125
pmallick 0:3afcd581558d 126 /* Set polarity of PWM generator device */
pmallick 0:3afcd581558d 127 int32_t pwm_set_polarity(struct pwm_desc *desc,
pmallick 0:3afcd581558d 128 enum pwm_polarity polarity);
pmallick 0:3afcd581558d 129
pmallick 0:3afcd581558d 130 /* Set polarity of PWM generator device */
pmallick 0:3afcd581558d 131 int32_t pwm_get_polarity(struct pwm_desc *desc,
pmallick 0:3afcd581558d 132 enum pwm_polarity *polarity);
pmallick 0:3afcd581558d 133
pmallick 0:3afcd581558d 134 #endif