drv_pwm_trigger.h

Go to the documentation of this file.

/****************************************************************************
 *
 *   Copyright (c) 2017 PX4 Development Team. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name PX4 nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ****************************************************************************/

/**
 * @file PWM trigger output interface.
 *
 */

#pragma once

#include <px4_platform_common/defines.h>

#include <stdint.h>

__BEGIN_DECLS

/**
 * Intialise the PWM servo outputs using the specified configuration.
 *
 * @param channel_mask  Bitmask of channels (LSB = channel 0) to enable.
 *          This allows some of the channels to remain configured
 *          as GPIOs or as another function.
 * @return      OK on success.
 */
__EXPORT extern int up_pwm_trigger_init(uint32_t channel_mask);

/**
 * De-initialise the PWM trigger outputs.
 */
__EXPORT extern void    up_pwm_trigger_deinit(void);

/**
 * Arm or disarm trigger outputs.
 *
 * @bug This function should, but does not, guarantee that any pulse
 *      currently in progress is cleanly completed.
 *
 * @param armed     If true, outputs are armed; if false they
 *          are disarmed.
 */
__EXPORT extern void    up_pwm_trigger_arm(bool armed);

/**
 * Set the current output value for a channel.
 *
 * @param channel   The channel to set.
 * @param value     The output pulse width in microseconds.
 */
__EXPORT extern int up_pwm_trigger_set(unsigned channel, uint16_t value);

__END_DECLS