OpenCores
URL https://opencores.org/ocsvn/neorv32/neorv32/trunk

Subversion Repositories neorv32

[/] [neorv32/] [trunk/] [sw/] [lib/] [source/] [neorv32_pwm.c] - Blame information for rev 64

Go to most recent revision | Details | Compare with Previous | View Log

Line No. Rev Author Line
1 2 zero_gravi
// #################################################################################################
2
// # << NEORV32: neorv32_pwm.c - Pulse Width Modulation Controller (PWM) HW Driver >>              #
3
// # ********************************************************************************************* #
4
// # BSD 3-Clause License                                                                          #
5
// #                                                                                               #
6 44 zero_gravi
// # Copyright (c) 2021, Stephan Nolting. All rights reserved.                                     #
7 2 zero_gravi
// #                                                                                               #
8
// # Redistribution and use in source and binary forms, with or without modification, are          #
9
// # permitted provided that the following conditions are met:                                     #
10
// #                                                                                               #
11
// # 1. Redistributions of source code must retain the above copyright notice, this list of        #
12
// #    conditions and the following disclaimer.                                                   #
13
// #                                                                                               #
14
// # 2. Redistributions in binary form must reproduce the above copyright notice, this list of     #
15
// #    conditions and the following disclaimer in the documentation and/or other materials        #
16
// #    provided with the distribution.                                                            #
17
// #                                                                                               #
18
// # 3. Neither the name of the copyright holder nor the names of its contributors may be used to  #
19
// #    endorse or promote products derived from this software without specific prior written      #
20
// #    permission.                                                                                #
21
// #                                                                                               #
22
// # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS   #
23
// # OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF               #
24
// # MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE    #
25
// # COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,     #
26
// # EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE #
27
// # GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED    #
28
// # AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING     #
29
// # NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED  #
30
// # OF THE POSSIBILITY OF SUCH DAMAGE.                                                            #
31
// # ********************************************************************************************* #
32
// # The NEORV32 Processor - https://github.com/stnolting/neorv32              (c) Stephan Nolting #
33
// #################################################################################################
34
 
35
 
36
/**********************************************************************//**
37
 * @file neorv32_pwm.c
38
 * @author Stephan Nolting
39
 * @brief Pulse-Width Modulation Controller (PWM) HW driver source file.
40
 *
41 44 zero_gravi
 * @note These functions should only be used if the PWM unit was synthesized (IO_PWM_EN = true).
42 2 zero_gravi
 **************************************************************************/
43
 
44
#include "neorv32.h"
45
#include "neorv32_pwm.h"
46
 
47
 
48
/**********************************************************************//**
49
 * Check if PWM unit was synthesized.
50
 *
51
 * @return 0 if PWM was not synthesized, 1 if PWM is available.
52
 **************************************************************************/
53
int neorv32_pwm_available(void) {
54
 
55 64 zero_gravi
  if (NEORV32_SYSINFO.SOC & (1 << SYSINFO_SOC_IO_PWM)) {
56 2 zero_gravi
    return 1;
57
  }
58
  else {
59
    return 0;
60
  }
61
}
62
 
63
 
64
/**********************************************************************//**
65 64 zero_gravi
 * Enable and configure pulse width modulation controller. The PWM control register bits are listed in #NEORV32_PWM_CTRL_enum.
66 2 zero_gravi
 *
67
 * @param[in] prsc Clock prescaler select (0..7). See #NEORV32_CLOCK_PRSC_enum.
68
 **************************************************************************/
69
void neorv32_pwm_setup(uint8_t prsc) {
70
 
71 64 zero_gravi
  NEORV32_PWM.CTRL = 0; // reset
72 2 zero_gravi
 
73
  uint32_t ct_enable = 1;
74 64 zero_gravi
  ct_enable = ct_enable << PWM_CTRL_EN;
75 2 zero_gravi
 
76
  uint32_t ct_prsc = (uint32_t)(prsc & 0x07);
77 64 zero_gravi
  ct_prsc = ct_prsc << PWM_CTRL_PRSC0;
78 2 zero_gravi
 
79 64 zero_gravi
  NEORV32_PWM.CTRL = ct_enable | ct_prsc;
80 2 zero_gravi
}
81
 
82
 
83
/**********************************************************************//**
84
 * Disable pulse width modulation controller.
85
 **************************************************************************/
86
void neorv32_pwm_disable(void) {
87
 
88 64 zero_gravi
  NEORV32_PWM.CTRL &= ~((uint32_t)(1 << PWM_CTRL_EN));
89 2 zero_gravi
}
90
 
91
 
92
/**********************************************************************//**
93 61 zero_gravi
 * Enable pulse width modulation controller.
94
 **************************************************************************/
95
void neorv32_pwm_enable(void) {
96
 
97 64 zero_gravi
  NEORV32_PWM.CTRL |= ((uint32_t)(1 << PWM_CTRL_EN));
98 61 zero_gravi
}
99
 
100
 
101
/**********************************************************************//**
102 60 zero_gravi
 * Get number of implemented channels.
103
 * @warning This function will override all duty cycle configuration registers.
104 2 zero_gravi
 *
105 60 zero_gravi
 * @return Number of implemented channels.
106
 **************************************************************************/
107
int neorv32_pmw_get_num_channels(void) {
108
 
109
  neorv32_pwm_disable();
110
 
111
  uint8_t index = 0;
112
  uint8_t cnt = 0;
113
 
114
  for (index=0; index<60; index++) {
115
    neorv32_pwm_set(index, 1);
116
    cnt += neorv32_pwm_get(index);
117
  }
118
 
119
  return (int)cnt;
120
}
121
 
122
 
123
/**********************************************************************//**
124
 * Set duty cycle for channel.
125
 *
126
 * @param[in] channel Channel select (0..59).
127 2 zero_gravi
 * @param[in] duty Duty cycle (0..255).
128
 **************************************************************************/
129
void neorv32_pwm_set(uint8_t channel, uint8_t duty) {
130
 
131 60 zero_gravi
  if (channel > 59) {
132
    return; // out-of-range
133
  }
134 2 zero_gravi
 
135 60 zero_gravi
  // read-modify-write
136 2 zero_gravi
  uint32_t duty_mask = 0xff;
137
  uint32_t duty_new  = (uint32_t)duty;
138
 
139 64 zero_gravi
  duty_mask = duty_mask << ((channel % 4) * 8);
140
  duty_new  = duty_new  << ((channel % 4) * 8);
141 2 zero_gravi
 
142 64 zero_gravi
  uint32_t duty_cycle = NEORV32_PWM.DUTY[channel/4];
143 35 zero_gravi
 
144
  duty_cycle &= ~duty_mask; // clear previous duty cycle
145
  duty_cycle |= duty_new; // set new duty cycle
146
 
147 64 zero_gravi
  NEORV32_PWM.DUTY[channel/4] = duty_cycle;
148 2 zero_gravi
}
149 60 zero_gravi
 
150
 
151
/**********************************************************************//**
152
 * Get duty cycle from channel.
153
 *
154
 * @param[in] channel Channel select (0..59).
155
 * @return Duty cycle (0..255) of channel 'channel'.
156
 **************************************************************************/
157
uint8_t neorv32_pwm_get(uint8_t channel) {
158
 
159
  if (channel > 59) {
160
    return 0; // out-of-range
161
  }
162
 
163 64 zero_gravi
  uint32_t reg_data = NEORV32_PWM.DUTY[channel/4] >> (((channel % 4) * 8));
164 60 zero_gravi
 
165 64 zero_gravi
  return (uint8_t)reg_data;
166 60 zero_gravi
}

powered by: WebSVN 2.1.0

© copyright 1999-2024 OpenCores.org, equivalent to Oliscience, all rights reserved. OpenCores®, registered trademark.