306e19cb9f
Fix @file in many places. Also fix up the descriptions where it's appropriate. This standardizes the @file formatting across the library to explicitly include any parent directories up to the repository root. Besides being nice, this will hopefully let us manage Doxygen's XML output so as to make extracting series-specific pieces via Breathe in the leaflabs-docs repo possible. Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
57 lines
1.9 KiB
C
57 lines
1.9 KiB
C
/******************************************************************************
|
|
* The MIT License
|
|
*
|
|
* Copyright (c) 2010 Perry Hung.
|
|
*
|
|
* 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.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* @file wirish/include/wirish/pwm.h
|
|
* @brief Wiring-style PWM interface.
|
|
*/
|
|
|
|
#ifndef _WIRISH_PWM_H_
|
|
#define _WIRISH_PWM_H_
|
|
|
|
#include <libmaple/libmaple_types.h>
|
|
|
|
/**
|
|
* As a convenience, analogWrite is an alias of pwmWrite to ease
|
|
* porting Arduino code. However, period and duty will have to be
|
|
* recalibrated.
|
|
*/
|
|
#define analogWrite pwmWrite
|
|
|
|
/**
|
|
* Set the PWM duty on the given pin.
|
|
*
|
|
* User code is expected to determine and honor the maximum value
|
|
* (based on the configured period).
|
|
*
|
|
* @param pin PWM output pin
|
|
* @param duty_cycle Duty cycle to set.
|
|
*/
|
|
void pwmWrite(uint8 pin, uint16 duty_cycle);
|
|
|
|
#endif
|
|
|