Mistake on this page?
Report an issue in GitHub or email us
pwm_fpga_test.h
1 /* mbed Microcontroller Library
2  * Copyright (c) 2019 ARM Limited
3  * SPDX-License-Identifier: Apache-2.0
4  *
5  * Licensed under the Apache License, Version 2.0 (the "License");
6  * you may not use this file except in compliance with the License.
7  * You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17 
18 /** \addtogroup hal_pwmout_tests */
19 /** @{*/
20 
21 #ifndef MBED_FPGA_PWM_TEST_H
22 #define MBED_FPGA_PWM_TEST_H
23 
24 #if DEVICE_PWM
25 
26 #ifdef __cplusplus
27 extern "C" {
28 #endif
29 
30 /** Test that the PWM can be initialized/de-initialized using all possible
31  * PWM pins.
32  *
33  * Given board provides PWM support.
34  * When PWM is initialized (and then de-initialized) using valid PWM pin.
35  * Then the operation is successfull.
36  *
37  */
38 void fpga_pwm_init_free(PinName pin);
39 
40 /** Test that pwmout_period, pwmout_period_ms, pwmout_period_us functions sets the
41  * PWM period correctly and pwmout_write, pwmout_pulsewidth, pwmout_pulsewidth_ms,
42  * pwmout_pulsewidth_us functions sets the pulse width correctly.
43  *
44  * Given board provides PWM support.
45  * When PWM period/width is set using pwmout_period, pwmout_period_ms, pwmout_period_us/pwmout_write, pwmout_pulsewidth, pwmout_pulsewidth_ms, pwmout_pulsewidth_us
46  * Then the valid PWM puswidth and period is on output.
47  *
48  */
49 void fpga_pwm_period_fill_test(PinName pin);
50 
51 /**@}*/
52 
53 #ifdef __cplusplus
54 }
55 #endif
56 
57 #endif
58 
59 #endif
60 
61 /**@}*/
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.