Pratyush Mallick / Mbed OS nano_dac

this is testing

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

Committer:
pmallick
Date:
Thu Jan 14 19:12:57 2021 +0530
Revision:
0:e8a1ba50c46b
this is testing

Who changed what in which revision?

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