diff options
author | patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> | 2011-12-19 23:06:41 +0000 |
---|---|---|
committer | patacongo <patacongo@42af7a65-404d-4744-a932-0658087f49c3> | 2011-12-19 23:06:41 +0000 |
commit | 5fb7939d769fb3f1f84721cb0056d0cc621f05e2 (patch) | |
tree | eadad8142fada4d8cb57c09e438d6535bbd65d53 /apps/examples/pwm/pwm.h | |
parent | ef92b45bc404a1aaf0ab43a1603712f9bfc72311 (diff) | |
download | nuttx-5fb7939d769fb3f1f84721cb0056d0cc621f05e2.tar.gz nuttx-5fb7939d769fb3f1f84721cb0056d0cc621f05e2.tar.bz2 nuttx-5fb7939d769fb3f1f84721cb0056d0cc621f05e2.zip |
Add a test for PWM drivers
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4202 42af7a65-404d-4744-a932-0658087f49c3
Diffstat (limited to 'apps/examples/pwm/pwm.h')
-rwxr-xr-x | apps/examples/pwm/pwm.h | 126 |
1 files changed, 126 insertions, 0 deletions
diff --git a/apps/examples/pwm/pwm.h b/apps/examples/pwm/pwm.h new file mode 100755 index 000000000..83d87517c --- /dev/null +++ b/apps/examples/pwm/pwm.h @@ -0,0 +1,126 @@ +/**************************************************************************** + * examples/examples/pwm.h + * + * Copyright (C) 2011 Gregory Nutt. All rights reserved. + * Author: Gregory Nutt <gnutt@nuttx.org> + * + * 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 NuttX 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. + * + ****************************************************************************/ + +#ifndef __APPS_EXAMPLES_PWM_PWM_H +#define __APPS_EXAMPLES_PWM_PWM_H + +/**************************************************************************** + * Included Files + ****************************************************************************/ + +#include <nuttx/config.h> + +/**************************************************************************** + * Definitions + ****************************************************************************/ +/* Configuration ************************************************************/ +/* CONFIG_NSH_BUILTIN_APPS - Build the PWM test as an NSH built-in function. + * Default: Not built! The example can only be used as an NSH built-in + * application + * CONFIG_EXAMPLES_PWM_DEVPATH - The path to the PWM device. Default: /dev/pwm0 + * CONFIG_EXAMPLES_PWM_FREQUENCY - The initial PWM frequency. Default: 100 Hz + * CONFIG_EXAMPLES_PWM_DUTYPCT - The initial PWM duty as a percentage. Default: 50% + * CONFIG_EXAMPLES_PWM_DURATION - The initial PWM pulse train duration in sectonds. + * as a percentage. Default: 5 seconds + */ + +#ifndef CONFIG_PWM +# error "PWM device support is not enabled (CONFIG_PWM)" +#endif + +#ifndef CONFIG_NSH_BUILTIN_APPS +# warning "The PWM example only works as an NSH built-in application (CONFIG_NSH_BUILTIN_APPS)" +#endif + +#ifndef CONFIG_EXAMPLES_PWM_DEVPATH +# define CONFIG_EXAMPLES_PWM_DEVPATH "/dev/pwm0" +#endif + +#ifndef CONFIG_EXAMPLES_PWM_FREQUENCY +# define CONFIG_EXAMPLES_PWM_FREQUENCY 100 +#endif + +#ifndef CONFIG_EXAMPLES_PWM_DUTYPCT +# define CONFIG_EXAMPLES_PWM_DUTYPCT 50 +#endif + +#ifndef CONFIG_EXAMPLES_PWM_DURATION +# define CONFIG_EXAMPLES_PWM_DURATION 5 +#endif + +/* Debug ********************************************************************/ + +#ifdef CONFIG_CPP_HAVE_VARARGS +# ifdef CONFIG_DEBUG +# define message(...) lib_rawprintf(__VA_ARGS__) +# define msgflush() +# else +# define message(...) printf(__VA_ARGS__) +# define msgflush() fflush(stdout) +# endif +#else +# ifdef CONFIG_DEBUG +# define message lib_rawprintf +# define msgflush() +# else +# define message printf +# define msgflush() fflush(stdout) +# endif +#endif + +/**************************************************************************** + * Public Types + ****************************************************************************/ + +/**************************************************************************** + * Public Variables + ****************************************************************************/ + +/**************************************************************************** + * Public Function Prototypes + ****************************************************************************/ + +/**************************************************************************** + * Name: pwm_devinit() + * + * Description: + * Perform architecuture-specific initialization of the PWM hardware. This + * interface must be provided by all configurations using apps/examples/pwm + * + ****************************************************************************/ + +int pwm_devinit(void); + +#endif /* __APPS_EXAMPLES_PWM_PWM_H */ |