source: rtems/bsps/arm/beagle/include/bsp/pwmss.h @ 320cb42

Last change on this file since 320cb42 was 320cb42, checked in by James Fitzsimons <james.fitzsimons@…>, on 02/23/21 at 08:18:40

bsps/beagle: Updating licences to latest BSD 2 clause

  • Property mode set to 100644
File size: 2.6 KB
Line 
1/**
2 * @file
3 *
4 * @ingroup arm_beagle
5 *
6 * @brief Shared PWMSS module functions used by PWM, eQEP and eCAP (when added).
7 */
8
9/*
10 * SPDX-License-Identifier: BSD-2-Clause
11 *
12 * Copyright (c) 2020, 2021 James Fitzsimons <james.fitzsimons@gmail.com>
13 *
14 * Redistribution and use in source and binary forms, with or without
15 * modification, are permitted provided that the following conditions
16 * are met:
17 * 1. Redistributions of source code must retain the above copyright
18 *    notice, this list of conditions and the following disclaimer.
19 * 2. Redistributions in binary form must reproduce the above copyright
20 *    notice, this list of conditions and the following disclaimer in the
21 *    documentation and/or other materials provided with the distribution.
22 *
23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
33 * POSSIBILITY OF SUCH DAMAGE.
34 */
35
36#ifndef LIBBSP_ARM_BEAGLE_PWMSS_H
37#define LIBBSP_ARM_BEAGLE_PWMSS_H
38
39#ifdef __cplusplus
40extern "C" {
41#endif /* __cplusplus */
42
43/* The following definitions are bitmasks for the clk control registers for
44 * the PWMSS module clocks. All three modules have the same clock control
45 * hence the EPMSSx to signify these values are consistent across all
46 * EPWMSS instances. */
47#define AM335X_CM_PER_EPWMSSx_CLKCTRL_MODULEMODE_ENABLE   (0x2u)
48#define AM335X_CM_PER_EPWMSSx_CLKCTRL_MODULEMODE   (0x00000003u)
49#define AM335X_CM_PER_EPWMSSx_CLKCTRL_IDLEST_FUNC  (0x0u)
50#define AM335X_CM_PER_EPWMSSx_CLKCTRL_IDLEST_SHIFT (0x00000010u)
51#define AM335X_CM_PER_EPWMSSx_CLKCTRL_IDLEST       (0x00030000u)
52
53/**
54 * @brief The set of possible PWM subsystem module
55 *
56 * Enumerated type to define various instance of pwm module.
57 */
58typedef enum {
59  BBB_PWMSS0 = 0,
60  BBB_PWMSS1,
61  BBB_PWMSS2,
62  BBB_PWMSS_COUNT
63} BBB_PWMSS;
64
65
66rtems_status_code pwmss_module_clk_config(BBB_PWMSS pwmss_id);
67
68#ifdef __cplusplus
69}
70#endif /* __cplusplus */
71
72#endif /* LIBBSP_ARM_BEAGLE_PWMSS_H */
Note: See TracBrowser for help on using the repository browser.