mbed official / mbed

The official Mbed 2 C/C++ SDK provides the software platform and libraries to build your applications.

Dependents:   hello SerialTestv11 SerialTestv12 Sierpinski ... more

mbed 2

This is the mbed 2 library. If you'd like to learn about Mbed OS please see the mbed-os docs.

pwmout_api.h@122:f9eeca106725, 2016-07-07 (annotated)

Committer:
Kojto
Date:
Thu Jul 07 14:34:11 2016 +0100
Revision:
122:f9eeca106725
Parent:
65:5798e58a58b1 
Release 122 of the mbed library



Changes:

- new targets - Nucleo L432KC, Beetle, Nucleo F446ZE, Nucleo L011K4

- Thread safety addition - mbed API should contain a statement about thread safety

- critical section API addition

- CAS API (core_util_atomic_incr/decr)

- DEVICE_ are generated from targets.json file, device.h deprecated

- Callback replaces FunctionPointer to provide std like interface

- mbed HAL API docs improvements

- toolchain - prexif attributes with MBED_

            - add new attributes - packed, weak, forcedinline, align

- target.json - contains targets definitions

- ST - L1XX - Cube update to 1.5

     - SPI clock selection fix (clock from APB domain)

     - F7 - Cube update v1.4.0

     - L0 -  baudrate init fix

     - L1 - Cube update v1.5

     - F3 - baudrate init fix, 3 targets CAN support

     - F4 - Cube update v1.12.0, 3 targets CAN support

     - L4XX - Cube update v1.5.1

     - F0 - update Cube to v1.5.0

     - L4 - 2 targets (L476RG/VG) CAN support

- NXP - pwm clock fix for KSDK2 MCU

      - LPC2368 - remove ARM toolchain support - due to regression

      - KSDK2 - fix SPI , I2C address and repeat start

- Silabs - some fixes backported from mbed 3

- Renesas - RZ_A1H - SystemCoreClockUpdate addition

Who changed what in which revision?

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