include/bsp/pwmss.h

0001 /**
0002  * @file
0003  *
0004  * @ingroup arm_beagle
0005  *
0006  * @brief Shared PWMSS module functions used by PWM, eQEP and eCAP (when added).
0007  */
0008
0009 /*
0010  * SPDX-License-Identifier: BSD-2-Clause
0011  *
0012  * Copyright (c) 2020, 2021 James Fitzsimons <james.fitzsimons@gmail.com>
0013  *
0014  * Redistribution and use in source and binary forms, with or without
0015  * modification, are permitted provided that the following conditions
0016  * are met:
0017  * 1. Redistributions of source code must retain the above copyright
0018  *    notice, this list of conditions and the following disclaimer.
0019  * 2. Redistributions in binary form must reproduce the above copyright
0020  *    notice, this list of conditions and the following disclaimer in the
0021  *    documentation and/or other materials provided with the distribution.
0022  *
0023  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
0024  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
0025  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
0026  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
0027  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
0028  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
0029  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
0030  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
0031  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
0032  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
0033  * POSSIBILITY OF SUCH DAMAGE.
0034  */
0035
0036 #ifndef LIBBSP_ARM_BEAGLE_PWMSS_H
0037 #define LIBBSP_ARM_BEAGLE_PWMSS_H
0038
0039 #ifdef __cplusplus
0040 extern "C" {
0041 #endif /* __cplusplus */
0042
0043 /* The following definitions are bitmasks for the clk control registers for
0044  * the PWMSS module clocks. All three modules have the same clock control
0045  * hence the EPMSSx to signify these values are consistent across all
0046  * EPWMSS instances. */
0047 #define AM335X_CM_PER_EPWMSSx_CLKCTRL_MODULEMODE_ENABLE   (0x2u)
0048 #define AM335X_CM_PER_EPWMSSx_CLKCTRL_MODULEMODE   (0x00000003u)
0049 #define AM335X_CM_PER_EPWMSSx_CLKCTRL_IDLEST_FUNC  (0x0u)
0050 #define AM335X_CM_PER_EPWMSSx_CLKCTRL_IDLEST_SHIFT (0x00000010u)
0051 #define AM335X_CM_PER_EPWMSSx_CLKCTRL_IDLEST       (0x00030000u)
0052
0053 /**
0054  * @brief The set of possible PWM subsystem module
0055  *
0056  * Enumerated type to define various instance of pwm module.
0057  */
0058 typedef enum {
0059   BBB_PWMSS0 = 0,
0060   BBB_PWMSS1,
0061   BBB_PWMSS2,
0062   BBB_PWMSS_COUNT
0063 } BBB_PWMSS;
0064
0065
0066 rtems_status_code pwmss_module_clk_config(BBB_PWMSS pwmss_id);
0067
0068 #ifdef __cplusplus
0069 }
0070 #endif /* __cplusplus */
0071
0072 #endif /* LIBBSP_ARM_BEAGLE_PWMSS_H */