periph_cpu_common.h
Go to the documentation of this file.
1 /*
2  * SPDX-FileCopyrightText: 2015 Freie Universität Berlin
3  * SPDX-License-Identifier: LGPL-2.1-only
4  */
5 
6 #pragma once
7 
18 #include <stdbool.h>
19 
20 #include "bitarithm.h"
21 #include "compiler_hints.h"
22 #include "cpu.h"
23 #include "msp430_regs.h"
24 
25 #ifdef __cplusplus
26 extern "C" {
27 #endif
28 
33 #define HAVE_GPIO_T
34 typedef uint16_t gpio_t;
40 #define GPIO_UNDEF (0xffff)
41 
45 #define GPIO_PIN(x, y) ((gpio_t)(((x & 0xff) << 8) | (1 << (y & 0x07))))
46 
50 #define SPI_HWCS(x) (SPI_CS_UNDEF)
51 
61 #define TIMER_CHANNEL_NUMOF 7
62 
66 #define RAMSTART 0x200
67 
72 #define HAVE_GPIO_FLANK_T
76 typedef enum {
77  GPIO_FALLING = 0xff,
78  GPIO_RISING = 0x00,
79  GPIO_BOTH = 0xab
86 enum {
87  P1 = 1,
88  P2 = 2,
89  P3 = 3,
90  P4 = 4,
91  P5 = 5,
92  P6 = 6,
93 };
94 
95 #ifndef DOXYGEN
96 #define HAVE_GPIO_STATE_T
97 typedef enum {
98  GPIO_INPUT,
104 } gpio_state_t;
105 
106 #define HAVE_GPIO_SLEW_T
107 typedef enum {
108  GPIO_SLEW_SLOWEST = 0,
109  GPIO_SLEW_SLOW = 0,
110  GPIO_SLEW_FAST = 0,
111  GPIO_SLEW_FASTEST = 0,
112 } gpio_slew_t;
113 
114 #define HAVE_GPIO_PULL_STRENGTH_T
115 typedef enum {
116  GPIO_PULL_WEAKEST = 0,
117  GPIO_PULL_WEAK = 0,
118  GPIO_PULL_STRONG = 0,
121 
122 #define HAVE_GPIO_DRIVE_STRENGTH_T
123 typedef enum {
124  GPIO_DRIVE_WEAKEST = 0,
125  GPIO_DRIVE_WEAK = 0,
126  GPIO_DRIVE_STRONG = 0,
129 #endif /* !DOXYGEN */
130 
137 void gpio_periph_mode(gpio_t pin, bool enable);
138 
145 extern uint32_t msp430_dco_freq;
146 
150 typedef enum {
169 
173 typedef enum {
198 
202 typedef enum {
220 
224 typedef enum {
242 
246 typedef enum {
264 
277 typedef struct {
293  uint32_t lfxt1_frequency;
300  uint32_t xt2_frequency;
333  bool has_r_osc;
338  bool has_xt2;
340 
344 typedef enum {
350 
356 typedef enum {
361 
365 typedef struct {
375 } timer_conf_t;
376 
408 
412 extern msp430_timer_t TIMER_A;
413 
421 extern REG16 TIMER_A_IRQFLAGS;
422 
430 extern REG16 TIMER_B_IRQFLAGS;
431 
435 extern msp430_timer_t TIMER_B;
453 
463 void clock_init(void);
464 
471 
478 
489 
500 
501 #ifdef __cplusplus
502 }
503 #endif
504 
Helper functions for bit arithmetic.
Common macros and compiler attributes/pragmas configuration.
#define PURE
The function has no effects except the return value and its return value depends only on the paramete...
gpio_pull_strength_t
Enumeration of pull resistor values.
Definition: gpio_ll.h:275
gpio_state_t
Enumeration of GPIO states (direction)
Definition: gpio_ll.h:165
gpio_slew_t
Enumeration of slew rate settings.
Definition: gpio_ll.h:339
gpio_drive_strength_t
Enumeration of drive strength options.
Definition: gpio_ll.h:306
@ GPIO_PULL_WEAKEST
Use the weakest (highest Ohm value) resistor.
Definition: gpio_ll.h:276
@ GPIO_PULL_WEAK
Use a weak pull resistor.
Definition: gpio_ll.h:277
@ GPIO_PULL_STRONG
Use a strong pull resistor.
Definition: gpio_ll.h:278
@ GPIO_PULL_STRONGEST
Use the strongest pull resistor.
Definition: gpio_ll.h:279
@ GPIO_OUTPUT_OPEN_SOURCE
Use pin as output in open emitter configuration.
Definition: gpio_ll.h:202
@ GPIO_USED_BY_PERIPHERAL
The GPIO pin is used by a peripheral.
Definition: gpio_ll.h:221
@ GPIO_OUTPUT_OPEN_DRAIN
Use pin as output in open collector configuration.
Definition: gpio_ll.h:189
@ GPIO_OUTPUT_PUSH_PULL
Use pin as output in push-pull configuration.
Definition: gpio_ll.h:176
@ GPIO_DISCONNECT
Disconnect pin from all peripherals.
Definition: gpio_ll.h:249
@ GPIO_INPUT
Use pin as input.
Definition: gpio_ll.h:208
@ GPIO_SLEW_SLOWEST
let the output voltage level rise/fall as slow as possible
Definition: gpio_ll.h:340
@ GPIO_SLEW_FAST
let the output voltage level rise/fall fast
Definition: gpio_ll.h:343
@ GPIO_SLEW_SLOW
let the output voltage level rise/fall slowly
Definition: gpio_ll.h:342
@ GPIO_SLEW_FASTEST
let the output voltage level rise/fall as fast as possible
Definition: gpio_ll.h:344
@ GPIO_DRIVE_STRONG
Use a strong drive strength.
Definition: gpio_ll.h:309
@ GPIO_DRIVE_WEAK
Use a weak drive strength.
Definition: gpio_ll.h:308
@ GPIO_DRIVE_STRONGEST
Use the strongest drive strength.
Definition: gpio_ll.h:310
@ GPIO_DRIVE_WEAKEST
Use the weakest drive strength.
Definition: gpio_ll.h:307
unsigned int gpio_t
GPIO type identifier.
Definition: gpio.h:91
@ GPIO_FALLING
emit interrupt on falling flank
@ GPIO_RISING
emit interrupt on rising flank
@ GPIO_BOTH
not supported -> random value
msp430_port_p3_p6_t PORT_5
Register map of GPIO PORT 5.
gpio_flank_t
Enumeration of supported GPIO flanks.
msp430_timer_t TIMER_A
Register map of the timer A control registers.
msp430_clock_t
IDs of the different clock domains on the MSP430.
@ MSP430_CLOCK_AUXILIARY
Auxiliary clock.
@ MSP430_CLOCK_NUMOF
Number of clock domains.
@ MSP430_CLOCK_SUBMAIN
Subsystem main clock.
msp430_main_clock_source_t
Possible clock sources to generate the main clock from.
@ MAIN_CLOCK_SOURCE_XT2CLK
High frequency crystal between 450 kHz and 8 MHz.
@ MAIN_CLOCK_SOURCE_DCOCLK
Internal digitally controlled oscillator (DCO) with RC-type characteristics.
@ MAIN_CLOCK_SOURCE_LFXT1CLK
Low frequency 32.768 kHz or high frequency crystal between 450 kHz and 8 MHz.
uint32_t PURE msp430_submain_clock_freq(void)
Get the configured submain clock frequency.
msp430_timer_t TIMER_B
Register map of the timer B control registers.
msp430_port_p1_p2_t PORT_2
Register map of GPIO PORT 2.
void clock_init(void)
Call during boot up process to initialize the clock.
msp430_port_p1_p2_t PORT_1
Register map of GPIO PORT 1.
msp430_submain_clock_source_t
Possible clock sources to generate the submain clock from.
@ SUBMAIN_CLOCK_SOURCE_LFXT1CLK
Low frequency 32.768 kHz or high frequency crystal between 450 kHz and 8 MHz.
@ SUBMAIN_CLOCK_SOURCE_DCOCLK
Internal digitally controlled oscillator (DCO) with RC-type characteristics.
@ SUBMAIN_CLOCK_SOURCE_XT2CLK
High frequency crystal between 450 kHz and 8 MHz.
msp430_port_p3_p6_t PORT_6
Register map of GPIO PORT 6.
REG16 TIMER_B_IRQFLAGS
IRQ flags for TIMER_B.
void msp430_clock_release(msp430_clock_t clock)
Decrease the refcount of the subsystem main clock.
REG16 TIMER_A_IRQFLAGS
IRQ flags for TIMER_A.
msp430_submain_clock_divider_t
Clock dividers for the submain clock.
@ SUBMAIN_CLOCK_DIVIDE_BY_2
Divide the main clock by 2.
@ SUBMAIN_CLOCK_DIVIDE_BY_8
Divide the main clock by 8.
@ SUBMAIN_CLOCK_DIVIDE_BY_1
Divide the main clock by 1.
@ SUBMAIN_CLOCK_DIVIDE_BY_4
Divide the main clock by 4.
msp430_auxiliary_clock_divider_t
Clock dividers for the auxiliary clock.
@ AUXILIARY_CLOCK_DIVIDE_BY_4
Divide the main clock by 4.
@ AUXILIARY_CLOCK_DIVIDE_BY_1
Divide the main clock by 1.
@ AUXILIARY_CLOCK_DIVIDE_BY_2
Divide the main clock by 2.
@ AUXILIARY_CLOCK_DIVIDE_BY_8
Divide the main clock by 8.
uint32_t PURE msp430_auxiliary_clock_freq(void)
Get the configured auxiliary clock frequency.
msp430_port_p3_p6_t PORT_4
Register map of GPIO PORT 4.
msp430_timer_clock_source_t
Enumeration of possible clock sources for a timer.
@ TIMER_CLOCK_SOURCE_AUXILIARY_CLOCK
Auxiliary clock as clock source.
@ TIMER_CLOCK_SOURCE_TXCLK
External TxCLK as clock source.
@ TIMER_CLOCK_SOURCE_SUBMAIN_CLOCK
Sub-system master clock as clock source.
@ TIMER_CLOCK_SOURCE_INCLK
External INCLK as clock source.
void msp430_clock_acquire(msp430_clock_t clock)
Increase the refcount of the given clock.
msp430_main_clock_divider_t
Clock dividers for the main clock.
@ MAIN_CLOCK_DIVIDE_BY_1
Divide the main clock by 1.
@ MAIN_CLOCK_DIVIDE_BY_8
Divide the main clock by 8.
@ MAIN_CLOCK_DIVIDE_BY_2
Divide the main clock by 2.
@ MAIN_CLOCK_DIVIDE_BY_4
Divide the main clock by 4.
uint32_t msp430_dco_freq
The measured DCO frequency.
void default_clock_init(void)
Initialize the basic clock system to provide the main clock, the subsystem clock, and the auxiliary c...
@ P6
PORT 6.
@ P1
PORT 1.
@ P4
PORT 4.
@ P3
PORT 3.
@ P2
PORT 2.
@ P5
PORT 5.
msp430_port_p3_p6_t PORT_3
Register map of GPIO PORT 3.
void gpio_periph_mode(gpio_t pin, bool enable)
Enable or disable a pin to be used by peripheral modules.
#define TXSSEL_SMCLK
Sub-system master clock as clock source.
#define TXSSEL_TXCLK
External TxCLK as clock source.
#define TXSSEL_ACLK
Auxiliary clock as clock source.
#define TXSSEL_INCLK
External INCLK as clock source.
Native CPU header.
#define REG16(ADDR)
Type for 16-bit registers.
Definition: periph_gba.h:36
MSP430Fxzy Basic Clock System Parameters.
msp430_main_clock_source_t main_clock_source
The clock source to select for the main clock.
uint32_t lfxt1_frequency
The frequency of the LFXT1 crystal in Hz.
msp430_auxiliary_clock_divider_t auxiliary_clock_divier
Divider of the auxiliary clock.
uint32_t xt2_frequency
The frequency of the XT2 crystal in Hz.
msp430_submain_clock_source_t submain_clock_source
The clock source to select for the submain CPU clock.
uint32_t target_dco_frequency
The target frequency to run the DCO at in Hz.
msp430_submain_clock_divider_t submain_clock_divier
Divider of the submain clock.
bool has_xt2
A high frequency crystal (e.g.
msp430_main_clock_divider_t main_clock_divier
Divider of the main clock.
bool has_r_osc
An external resistor connected to source the current for the DCO.
GPIO Port 1/2 (with interrupt functionality)
Definition: msp430_regs.h:59
GPIO Port 3..6 (without interrupt functionality)
Timer peripheral registers.
Timer device configuration.
Definition: periph_cpu.h:260
msp430_timer_t * timer
Hardware timer to use.
REG16 * irq_flags
"Timer interrupt vector" register
msp430_timer_clock_source_t clock_source
Clock source to use.