ON Semiconductor / mbed-os

5.2.1 - Updated I2C files

Dependents:   mbed-TFT-example-NCS36510 mbed-Accelerometer-example-NCS36510 mbed-Accelerometer-example-NCS36510

hal/pwmout_api.h@1:f30bdcd2b33b, 2017-02-27 (annotated)

Committer:
jacobjohnson
Date:
Mon Feb 27 17:45:05 2017 +0000
Revision:
1:f30bdcd2b33b
Parent:
0:098463de4c5d 
changed the inputscale from 1 to 7 in analogin_api.c.  This will need to be changed later, and accessed from the main level, but for now this allows the  adc to read a value from 0 to 3.7V, instead of just up to 1V.;

Who changed what in which revision?

UserRevisionLine numberNew contents of line
group-onsemi 0:098463de4c5d 1
group-onsemi 0:098463de4c5d 2 /** \addtogroup hal */
group-onsemi 0:098463de4c5d 3 /** @{*/
group-onsemi 0:098463de4c5d 4 /* mbed Microcontroller Library
group-onsemi 0:098463de4c5d 5 * Copyright (c) 2006-2013 ARM Limited
group-onsemi 0:098463de4c5d 6 *
group-onsemi 0:098463de4c5d 7 * Licensed under the Apache License, Version 2.0 (the "License");
group-onsemi 0:098463de4c5d 8 * you may not use this file except in compliance with the License.
group-onsemi 0:098463de4c5d 9 * You may obtain a copy of the License at
group-onsemi 0:098463de4c5d 10 *
group-onsemi 0:098463de4c5d 11 * http://www.apache.org/licenses/LICENSE-2.0
group-onsemi 0:098463de4c5d 12 *
group-onsemi 0:098463de4c5d 13 * Unless required by applicable law or agreed to in writing, software
group-onsemi 0:098463de4c5d 14 * distributed under the License is distributed on an "AS IS" BASIS,
group-onsemi 0:098463de4c5d 15 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
group-onsemi 0:098463de4c5d 16 * See the License for the specific language governing permissions and
group-onsemi 0:098463de4c5d 17 * limitations under the License.
group-onsemi 0:098463de4c5d 18 */
group-onsemi 0:098463de4c5d 19 #ifndef MBED_PWMOUT_API_H
group-onsemi 0:098463de4c5d 20 #define MBED_PWMOUT_API_H
group-onsemi 0:098463de4c5d 21
group-onsemi 0:098463de4c5d 22 #include "device.h"
group-onsemi 0:098463de4c5d 23
group-onsemi 0:098463de4c5d 24 #if DEVICE_PWMOUT
group-onsemi 0:098463de4c5d 25
group-onsemi 0:098463de4c5d 26 #ifdef __cplusplus
group-onsemi 0:098463de4c5d 27 extern "C" {
group-onsemi 0:098463de4c5d 28 #endif
group-onsemi 0:098463de4c5d 29
group-onsemi 0:098463de4c5d 30 /** Pwmout hal structure. pwmout_s is declared in the target's hal
group-onsemi 0:098463de4c5d 31 */
group-onsemi 0:098463de4c5d 32 typedef struct pwmout_s pwmout_t;
group-onsemi 0:098463de4c5d 33
group-onsemi 0:098463de4c5d 34 /**
group-onsemi 0:098463de4c5d 35 * \defgroup hal_pwmout Pwmout hal functions
group-onsemi 0:098463de4c5d 36 * @{
group-onsemi 0:098463de4c5d 37 */
group-onsemi 0:098463de4c5d 38
group-onsemi 0:098463de4c5d 39 /** Initialize the pwm out peripheral and configure the pin
group-onsemi 0:098463de4c5d 40 *
group-onsemi 0:098463de4c5d 41 * @param obj The pwmout object to initialize
group-onsemi 0:098463de4c5d 42 * @param pin The pwmout pin to initialize
group-onsemi 0:098463de4c5d 43 */
group-onsemi 0:098463de4c5d 44 void pwmout_init(pwmout_t *obj, PinName pin);
group-onsemi 0:098463de4c5d 45
group-onsemi 0:098463de4c5d 46 /** Deinitialize the pwmout object
group-onsemi 0:098463de4c5d 47 *
group-onsemi 0:098463de4c5d 48 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 49 */
group-onsemi 0:098463de4c5d 50 void pwmout_free(pwmout_t *obj);
group-onsemi 0:098463de4c5d 51
group-onsemi 0:098463de4c5d 52 /** Set the output duty-cycle in range <0.0f, 1.0f>
group-onsemi 0:098463de4c5d 53 *
group-onsemi 0:098463de4c5d 54 * Value 0.0f represents 0 percentage, 1.0f represents 100 percent.
group-onsemi 0:098463de4c5d 55 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 56 * @param percent The floating-point percentage number
group-onsemi 0:098463de4c5d 57 */
group-onsemi 0:098463de4c5d 58 void pwmout_write(pwmout_t *obj, float percent);
group-onsemi 0:098463de4c5d 59
group-onsemi 0:098463de4c5d 60 /** Read the current float-point output duty-cycle
group-onsemi 0:098463de4c5d 61 *
group-onsemi 0:098463de4c5d 62 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 63 * @return A floating-point output duty-cycle
group-onsemi 0:098463de4c5d 64 */
group-onsemi 0:098463de4c5d 65 float pwmout_read(pwmout_t *obj);
group-onsemi 0:098463de4c5d 66
group-onsemi 0:098463de4c5d 67 /** Set the PWM period specified in seconds, keeping the duty cycle the same
group-onsemi 0:098463de4c5d 68 *
group-onsemi 0:098463de4c5d 69 * Periods smaller than microseconds (the lowest resolution) are set to zero.
group-onsemi 0:098463de4c5d 70 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 71 * @param seconds The floating-point seconds period
group-onsemi 0:098463de4c5d 72 */
group-onsemi 0:098463de4c5d 73 void pwmout_period(pwmout_t *obj, float seconds);
group-onsemi 0:098463de4c5d 74
group-onsemi 0:098463de4c5d 75 /** Set the PWM period specified in miliseconds, keeping the duty cycle the same
group-onsemi 0:098463de4c5d 76 *
group-onsemi 0:098463de4c5d 77 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 78 * @param ms The milisecond period
group-onsemi 0:098463de4c5d 79 */
group-onsemi 0:098463de4c5d 80 void pwmout_period_ms(pwmout_t *obj, int ms);
group-onsemi 0:098463de4c5d 81
group-onsemi 0:098463de4c5d 82 /** Set the PWM period specified in microseconds, keeping the duty cycle the same
group-onsemi 0:098463de4c5d 83 *
group-onsemi 0:098463de4c5d 84 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 85 * @param us The microsecond period
group-onsemi 0:098463de4c5d 86 */
group-onsemi 0:098463de4c5d 87 void pwmout_period_us(pwmout_t *obj, int us);
group-onsemi 0:098463de4c5d 88
group-onsemi 0:098463de4c5d 89 /** Set the PWM pulsewidth specified in seconds, keeping the period the same.
group-onsemi 0:098463de4c5d 90 *
group-onsemi 0:098463de4c5d 91 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 92 * @param seconds The floating-point pulsewidth in seconds
group-onsemi 0:098463de4c5d 93 */
group-onsemi 0:098463de4c5d 94 void pwmout_pulsewidth(pwmout_t *obj, float seconds);
group-onsemi 0:098463de4c5d 95
group-onsemi 0:098463de4c5d 96 /** Set the PWM pulsewidth specified in miliseconds, keeping the period the same.
group-onsemi 0:098463de4c5d 97 *
group-onsemi 0:098463de4c5d 98 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 99 * @param ms The floating-point pulsewidth in miliseconds
group-onsemi 0:098463de4c5d 100 */
group-onsemi 0:098463de4c5d 101 void pwmout_pulsewidth_ms(pwmout_t *obj, int ms);
group-onsemi 0:098463de4c5d 102
group-onsemi 0:098463de4c5d 103 /** Set the PWM pulsewidth specified in microseconds, keeping the period the same.
group-onsemi 0:098463de4c5d 104 *
group-onsemi 0:098463de4c5d 105 * @param obj The pwmout object
group-onsemi 0:098463de4c5d 106 * @param us The floating-point pulsewidth in microseconds
group-onsemi 0:098463de4c5d 107 */
group-onsemi 0:098463de4c5d 108 void pwmout_pulsewidth_us(pwmout_t *obj, int us);
group-onsemi 0:098463de4c5d 109
group-onsemi 0:098463de4c5d 110 /**@}*/
group-onsemi 0:098463de4c5d 111
group-onsemi 0:098463de4c5d 112 #ifdef __cplusplus
group-onsemi 0:098463de4c5d 113 }
group-onsemi 0:098463de4c5d 114 #endif
group-onsemi 0:098463de4c5d 115
group-onsemi 0:098463de4c5d 116 #endif
group-onsemi 0:098463de4c5d 117
group-onsemi 0:098463de4c5d 118 #endif
group-onsemi 0:098463de4c5d 119
group-onsemi 0:098463de4c5d 120 /** @}*/