summaryrefslogtreecommitdiff
path: root/nuttx/arch/arm/src/sam34/chip/sam_pmc.h
blob: a1d282e23b561248ffe7170fc7ebbf68604645ad (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
/********************************************************************************************
 * arch/arm/src/sam34/chip/sam_pmc.h
 * Power Management Controller (PMC) for the SAM3U, SAM3X, SAM3A, and SAM4S
 *
 *   Copyright (C) 2009, 2013 Gregory Nutt. All rights reserved.
 *   Author: Gregory Nutt <gnutt@nuttx.org>
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in
 *    the documentation and/or other materials provided with the
 *    distribution.
 * 3. Neither the name NuttX nor the names of its contributors may be
 *    used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
 * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
 * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 *
 ********************************************************************************************/

#ifndef __ARCH_ARM_SRC_SAM34_CHIP_SAM_PMC_H
#define __ARCH_ARM_SRC_SAM34_CHIP_SAM_PMC_H

/********************************************************************************************
 * Included Files
 ********************************************************************************************/

#include <nuttx/config.h>

#include "chip.h"
#include "chip/sam_memorymap.h"

/********************************************************************************************
 * Pre-processor Definitions
 ********************************************************************************************/

/* PMC register offsets *********************************************************************/

#define SAM_PMC_SCER_OFFSET              0x0000 /* System Clock Enable Register */
#define SAM_PMC_SCDR_OFFSET              0x0004 /* System Clock Disable Register */
#define SAM_PMC_SCSR_OFFSET              0x0008 /* System Clock Status Register */
                                                /* 0x000c: Reserved */
#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_PCER0_OFFSET           0x0010 /* Peripheral Clock Enable Register 0 */
#  define SAM_PMC_PCDR0_OFFSET           0x0014 /* Peripheral Clock Disable Register 0 */
#  define SAM_PMC_PCSR0_OFFSET           0x0018 /* Peripheral Clock Status Register 0 */
#elif defined(CONFIG_ARCH_CHIP_SAM3U)
#  define SAM_PMC_PCER_OFFSET            0x0010 /* Peripheral Clock Enable Register */
#  define SAM_PMC_PCDR_OFFSET            0x0014 /* Peripheral Clock Disable Register */
#  define SAM_PMC_PCSR_OFFSET            0x0018 /* Peripheral Clock Status Register */
#endif

#if defined(CONFIG_ARCH_CHIP_SAM3U) || defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A)
#  define SAM_PMC_CKGR_UCKR_OFFSET       0x001c /* UTMI Clock Register */
#endif
                                                /* 0x001c: Reserved (SAM4S)*/
#define SAM_PMC_CKGR_MOR_OFFSET          0x0020 /* Main Oscillator Register */
#define SAM_PMC_CKGR_MCFR_OFFSET         0x0024 /* Main Clock Frequency Register */
#define SAM_PMC_CKGR_PLLAR_OFFSET        0x0028 /* PLLA Register */

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_CKGR_PLLBR_OFFSET      0x002c /* PLLB Register */
#endif
                                                /* 0x002c: Reserved (SAM3U)*/
#define SAM_PMC_MCKR_OFFSET              0x0030 /* Master Clock Register */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
                                                /* 0x0034 Reserved */
#  define SAM_PMC_USB_OFFSET             0x0038 /* USB Clock Register PMC_USB */
                                                /* 0x003c Reserved */
#endif
                                                /* 0x0034-0x003c Reserved (SAM3U) */
#define SAM_PMC_PCK_OFFSET(n)            (0x0040 + ((n) << 2))
#define SAM_PMC_PCK0_OFFSET              0x0040 /* Programmable Clock 0 Register */
#define SAM_PMC_PCK1_OFFSET              0x0044 /* Programmable Clock 1 Register */
#define SAM_PMC_PCK2_OFFSET              0x0048 /* Programmable Clock 2 Register */
                                                /* 0x004c-0x005c: Reserved */
#define SAM_PMC_IER_OFFSET               0x0060 /* Interrupt Enable Register */
#define SAM_PMC_IDR_OFFSET               0x0064 /* Interrupt Disable Register */
#define SAM_PMC_SR_OFFSET                0x0068 /* Status Register */
#define SAM_PMC_IMR_OFFSET               0x006c /* Interrupt Mask Register */
#define SAM_PMC_FSMR_OFFSET              0x0070 /* Fast Startup Mode Register */
#define SAM_PMC_FSPR_OFFSET              0x0074 /* Fast Startup Polarity Register */
#define SAM_PMC_FOCR_OFFSET              0x0078 /* Fault Output Clear Register */
                                                /* 0x007c-0x00e0: Reserved */
#define SAM_PMC_WPMR_OFFSET              0x00e4 /* Write Protect Mode Register */
#define SAM_PMC_WPSR_OFFSET              0x00e8 /* Write Protect Status Register */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
                                                /* 0x00ec-0x00fc Reserved */
#  define SAM_PMC_PCER1_OFFSET           0x0100 /* Peripheral Clock Enable Register 1 */
#  define SAM_PMC_PCDR1_OFFSET           0x0104 /* Peripheral Clock Disable Register 1 */
#  define SAM_PMC_PCSR1_OFFSET           0x0108 /* Peripheral Clock Status Register 1 */
#endif
                                                /* 0x010c Reserved */
#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A)
#  define SAM_PMC_PCR_OFFSET             0x010c /* Peripheral Control Register */
#endif

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_OCR_OFFSET             0x0110 /* Oscillator Calibration Register */
                                                /* 0x003c Reserved */
#endif

/* PMC register adresses ********************************************************************/

#define SAM_PMC_SCER                     (SAM_PMC_BASE+SAM_PMC_SCER_OFFSET)
#define SAM_PMC_SCDR                     (SAM_PMC_BASE+SAM_PMC_SCDR_OFFSET)
#define SAM_PMC_SCSR                     (SAM_PMC_BASE+SAM_PMC_SCSR_OFFSET)

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_PCER0                  (SAM_PMC_BASE+SAM_PMC_PCER0_OFFSET)
#  define SAM_PMC_PCDR0                  (SAM_PMC_BASE+SAM_PMC_PCDR0_OFFSET)
#  define SAM_PMC_PCSR0                  (SAM_PMC_BASE+SAM_PMC_PCSR0_OFFSET)
#elif defined(CONFIG_ARCH_CHIP_SAM3U)
#  define SAM_PMC_PCER                   (SAM_PMC_BASE+SAM_PMC_PCER_OFFSET)
#  define SAM_PMC_PCDR                   (SAM_PMC_BASE+SAM_PMC_PCDR_OFFSET)
#  define SAM_PMC_PCSR                   (SAM_PMC_BASE+SAM_PMC_PCSR_OFFSET)
#endif

#if defined(CONFIG_ARCH_CHIP_SAM3U) || defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A)
#  define SAM_PMC_CKGR_UCKR              (SAM_PMC_BASE+SAM_PMC_CKGR_UCKR_OFFSET)
#endif

#define SAM_PMC_CKGR_MOR                 (SAM_PMC_BASE+SAM_PMC_CKGR_MOR_OFFSET)
#define SAM_PMC_CKGR_MCFR                (SAM_PMC_BASE+SAM_PMC_CKGR_MCFR_OFFSET)
#define SAM_PMC_CKGR_PLLAR               (SAM_PMC_BASE+SAM_PMC_CKGR_PLLAR_OFFSET)

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_CKGR_PLLBR             (SAM_PMC_BASE+SAM_PMC_CKGR_PLLBR_OFFSET)
#endif

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_USB                    (SAM_PMC_BASE+SAM_PMC_USB_OFFSET)
#endif

#define SAM_PMC_MCKR                     (SAM_PMC_BASE+SAM_PMC_MCKR_OFFSET)
#define SAM_PMC_PCK(n)                   (SAM_PMC_BASE+SAM_PMC_PCK_OFFSET(n))
#define SAM_PMC_PCK0                     (SAM_PMC_BASE+SAM_PMC_PCK0_OFFSET)
#define SAM_PMC_PCK1                     (SAM_PMC_BASE+SAM_PMC_PCK1_OFFSET)
#define SAM_PMC_PCK2                     (SAM_PMC_BASE+SAM_PMC_PCK2_OFFSET)
#define SAM_PMC_IER                      (SAM_PMC_BASE+SAM_PMC_IER_OFFSET)
#define SAM_PMC_IDR                      (SAM_PMC_BASE+SAM_PMC_IDR_OFFSET)
#define SAM_PMC_SR                       (SAM_PMC_BASE+SAM_PMC_SR_OFFSET)
#define SAM_PMC_IMR                      (SAM_PMC_BASE+SAM_PMC_IMR_OFFSET)
#define SAM_PMC_FSMR                     (SAM_PMC_BASE+SAM_PMC_FSMR_OFFSET)
#define SAM_PMC_FSPR                     (SAM_PMC_BASE+SAM_PMC_FSPR_OFFSET)
#define SAM_PMC_FOCR                     (SAM_PMC_BASE+SAM_PMC_FOCR_OFFSET)
#define SAM_PMC_WPMR                     (SAM_PMC_BASE+SAM_PMC_WPMR_OFFSET)
#define SAM_PMC_WPSR                     (SAM_PMC_BASE+SAM_PMC_WPSR_OFFSET)

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_PCER1                  (SAM_PMC_BASE+SAM_PMC_PCER1_OFFSET)
#  define SAM_PMC_PCDR1                  (SAM_PMC_BASE+SAM_PMC_PCDR1_OFFSET)
#  define SAM_PMC_PCSR1                  (SAM_PMC_BASE+SAM_PMC_PCSR1_OFFSET)
#endif

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A)
#  define SAM_PMC_PCR                    (SAM_PMC_BASE+SAM_PMC_PCR_OFFSET)
#endif

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define SAM_PMC_OCR                    (SAM_PMC_BASE+SAM_PMC_OCR_OFFSET)
#endif

/* PMC register bit definitions *************************************************************/

/* PMC System Clock Enable Register, PMC System Clock Disable Register, and PMC System
 * Clock Status Register common bit-field definitions
 */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_UOTGCLK                    (1 << 5)  /* Bit 5: Enable USB OTG Clock (48 MHz, USB_48M) for UTMI */
#endif

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_UDP                        (1 << 7)  /* Bit 7: USB Device Port Clock Enable */
#endif

#define PMC_PCK(n)                       (1 << ((n) + 8)
#define PMC_PCK0                         (1 << 8)  /* Bit 8:  Programmable Clock 0 Output Enable */
#define PMC_PCK1                         (1 << 9)  /* Bit 9:  Programmable Clock 1 Output Enable */
#define PMC_PCK2                         (1 << 10) /* Bit 10: Programmable Clock 2 Output Enable */

/* PMC Peripheral Clock Enable Register, PMC Peripheral Clock Disable Register, and PMC
 * Peripheral Clock Status Register common bit-field definitions.
 */

#define PMC_PIDL(n)                      (1 << (n))
#define PMC_PID2                         (1 << 2)  /* Bit 2:  Peripheral Clock 2  Enable */
#define PMC_PID3                         (1 << 3)  /* Bit 3:  Peripheral Clock 3  Enable */
#define PMC_PID4                         (1 << 4)  /* Bit 4:  Peripheral Clock 4  Enable */
#define PMC_PID5                         (1 << 5)  /* Bit 5:  Peripheral Clock 5  Enable */
#define PMC_PID6                         (1 << 6)  /* Bit 6:  Peripheral Clock 6  Enable */
#define PMC_PID7                         (1 << 7)  /* Bit 7:  Peripheral Clock 7  Enable */
#define PMC_PID8                         (1 << 8)  /* Bit 8:  Peripheral Clock 8  Enable */
#define PMC_PID9                         (1 << 9)  /* Bit 9:  Peripheral Clock 9  Enable */
#define PMC_PID10                        (1 << 10) /* Bit 10: Peripheral Clock 10 Enable */
#define PMC_PID11                        (1 << 11) /* Bit 11: Peripheral Clock 11 Enable */
#define PMC_PID12                        (1 << 12) /* Bit 12: Peripheral Clock 12 Enable */
#define PMC_PID13                        (1 << 13) /* Bit 13: Peripheral Clock 13 Enable */
#define PMC_PID14                        (1 << 14) /* Bit 14: Peripheral Clock 14 Enable */
#define PMC_PID15                        (1 << 15) /* Bit 15: Peripheral Clock 15 Enable */
#define PMC_PID16                        (1 << 16) /* Bit 16: Peripheral Clock 16 Enable */
#define PMC_PID17                        (1 << 17) /* Bit 17: Peripheral Clock 17 Enable */
#define PMC_PID18                        (1 << 18) /* Bit 18: Peripheral Clock 18 Enable */
#define PMC_PID19                        (1 << 19) /* Bit 19: Peripheral Clock 19 Enable */
#define PMC_PID20                        (1 << 20) /* Bit 20: Peripheral Clock 20 Enable */
#define PMC_PID21                        (1 << 21) /* Bit 21: Peripheral Clock 21 Enable */
#define PMC_PID22                        (1 << 22) /* Bit 22: Peripheral Clock 22 Enable */
#define PMC_PID23                        (1 << 23) /* Bit 23: Peripheral Clock 23 Enable */
#define PMC_PID24                        (1 << 24) /* Bit 24: Peripheral Clock 24 Enable */
#define PMC_PID25                        (1 << 25) /* Bit 25: Peripheral Clock 25 Enable */
#define PMC_PID26                        (1 << 26) /* Bit 26: Peripheral Clock 26 Enable */
#define PMC_PID27                        (1 << 27) /* Bit 27: Peripheral Clock 27 Enable */
#define PMC_PID28                        (1 << 28) /* Bit 28: Peripheral Clock 28 Enable */
#define PMC_PID29                        (1 << 29) /* Bit 29: Peripheral Clock 29 Enable */
#define PMC_PID30                        (1 << 30) /* Bit 30: Peripheral Clock 30 Enable */
#define PMC_PID31                        (1 << 31) /* Bit 31: Peripheral Clock 31 Enable */

/* PMC UTMI Clock Configuration Register */

#if defined(CONFIG_ARCH_CHIP_SAM3U) || defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A)
#  define PMC_CKGR_UCKR_UPLLEN           (1 << 16) /* Bit 16: UTMI PLL Enable */
#  define PMC_CKGR_UCKR_UPLLCOUNT_SHIFT  (20)      /* Bits 20-23: UTMI PLL Start-up Time */
#  define PMC_CKGR_UCKR_UPLLCOUNT_MASK   (15 << PMC_CKGR_UCKR_UPLLCOUNT_SHIFT)
#endif

/* PMC Clock Generator Main Oscillator Register */

#define PMC_CKGR_MOR_MOSCXTEN            (1 << 0)  /* Bit 0:  Main Crystal Oscillator Enable */
#define PMC_CKGR_MOR_MOSCXTBY            (1 << 1)  /* Bit 1:  Main Crystal Oscillator Bypass */

#if defined(CONFIG_ARCH_CHIP_SAM3U) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_CKGR_MOR_WAITMODE          (1 << 2)  /* Bit 2:  Wait Mode Command */
#endif

#define PMC_CKGR_MOR_MOSCRCEN            (1 << 3)  /* Bit 3:  Main On-Chip RC Oscillator Enable */
#define PMC_CKGR_MOR_MOSCRCF_SHIFT       (4)       /* Bits 4-6: Main On-Chip RC Oscillator Frequency Selection */
#define PMC_CKGR_MOR_MOSCRCF_MASK        (7 << PMC_CKGR_MOR_MOSCRCF_SHIFT)
#  define PMC_CKGR_MOR_MOSCRCF_4MHz      (0 << PMC_CKGR_MOR_MOSCRCF_SHIFT) /* Fast RC Osc is 4MHz (default) */
#  define PMC_CKGR_MOR_MOSCRCF_8MHz      (1 << PMC_CKGR_MOR_MOSCRCF_SHIFT) /* Fast RC Osc is 8MHz */
#  define PMC_CKGR_MOR_MOSCRCF_12MHz     (2 << PMC_CKGR_MOR_MOSCRCF_SHIFT) /* Fast RC Osc is 12MHz */
#define PMC_CKGR_MOR_MOSCXTST_SHIFT      (8)       /* Bits 8-16: Main Crystal Oscillator Start-up Time */
#define PMC_CKGR_MOR_MOSCXTST_MASK       (0x1ff << PMC_CKGR_MOR_MOSCXTST_SHIFT)
#define PMC_CKGR_MOR_KEY_SHIFT           (16)      /* Bits 16-23: Password */
#define PMC_CKGR_MOR_KEY_MASK            (0xff << PMC_CKGR_MOR_KEY_SHIFT)
#  define PMC_CKGR_MOR_KEY               (0x37 << PMC_CKGR_MOR_KEY_SHIFT)
#define PMC_CKGR_MOR_MOSCSEL             (1 << 24) /* Bit 24: Main Oscillator Selection */
#define PMC_CKGR_MOR_CFDEN               (1 << 25) /* Bit 25: Clock Failure Detector Enable */

/* PMC Clock Generator Main Clock Frequency Register */

#define PMC_CKGR_MCFR_MAINF_SHIFT        (0)       /* Bits 0-15: Main Clock Frequency */
#define PMC_CKGR_MCFR_MAINF_MASK         (0xffff << PMC_CKGR_MCFR_MAINF_SHIFT)
#define PMC_CKGR_MCFR_MAINFRDY           (1 << 16) /* Bit 16: Main Clock Ready */

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_CKGR_MCFR_RCMEAS           (1 << 20) /* Bit 20: RC Oscillator Frequency Measure (write-only) */
#endif

/* PMC Clock Generator PLLA Register */

#define PMC_CKGR_PLLAR_DIV_SHIFT         (0)       /* Bits 0-7: Divider */
#define PMC_CKGR_PLLAR_DIV_MASK          (0xff << PMC_CKGR_PLLAR_DIV_SHIFT)
#  define PMC_CKGR_PLLAR_DIV_ZERO        (0 << PMC_CKGR_PLLAR_DIV_SHIFT)   /* Divider output is 0 */
#  define PMC_CKGR_PLLAR_DIV_BYPASS      (1 << PMC_CKGR_PLLAR_DIV_SHIFT)   /* Divider is bypassed (DIV=1) */
#  define PMC_CKGR_PLLAR_DIV(n)          ((n) << PMC_CKGR_PLLAR_DIV_SHIFT) /* Divider output is DIV=n, n=2..255 */

#define PMC_CKGR_PLLAR_COUNT_SHIFT       (8)       /* Bits 8-13: PLLA Counter */
#define PMC_CKGR_PLLAR_COUNT_MASK        (63 << PMC_CKGR_PLLAR_COUNT_SHIFT)

#if defined(CONFIG_ARCH_CHIP_SAM3U)
#  define PMC_CKGR_PLLAR_STMODE_SHIFT    (14)      /* Bits 14-15: Start Mode */
#  define PMC_CKGR_PLLAR_STMODE_MASK     (3 << PMC_CKGR_PLLAR_STMODE_SHIFT)
#    define PMC_CKGR_PLLAR_STMODE_FAST   (0 << PMC_CKGR_PLLAR_STMODE_SHIFT) /* Fast Startup */
#    define PMC_CKGR_PLLAR_STMODE_NORMAL (2 << PMC_CKGR_PLLAR_STMODE_SHIFT) /* Normal Startup */
#endif

#define PMC_CKGR_PLLAR_MUL_SHIFT         (16)      /* Bits 16-26: PLLA Multiplier */
#define PMC_CKGR_PLLAR_MUL_MASK          (0x7ff << PMC_CKGR_PLLAR_MUL_SHIFT)
#define PMC_CKGR_PLLAR_ONE               (1 << 29) /* Bit 29: Always one */

/* PLLB Register */

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_CKGR_PLLBR_DIV_SHIFT       (0)       /* Bits 0-7: Divider */
#  define PMC_CKGR_PLLBR_DIV_MASK        (0xff << PMC_CKGR_PLLBR_DIV_SHIFT)
#    define PMC_CKGR_PLLBR_DIV_ZERO      (0 << PMC_CKGR_PLLBR_DIV_SHIFT)   /* Divider output is 0 */
#    define PMC_CKGR_PLLBR_DIV_BYPASS    (1 << PMC_CKGR_PLLBR_DIV_SHIFT)   /* Divider is bypassed (DIV=1) */
#    define PMC_CKGR_PLLBR_DIV(n)        ((n) << PMC_CKGR_PLLBR_DIV_SHIFT) /* Divider output is DIV=n, n=2..255 */
#  define PMC_CKGR_PLLBR_COUNT_SHIFT     (8)       /* Bits 8-13: PLLA Counter */
#  define PMC_CKGR_PLLBR_COUNT_MASK      (63 << PMC_CKGR_PLLBR_COUNT_SHIFT)
#  define PMC_CKGR_PLLBR_MUL_SHIFT       (16)      /* Bits 16-26: PLLA Multiplier */
#  define PMC_CKGR_PLLBR_MUL_MASK        (0x7ff << PMC_CKGR_PLLBR_MUL_SHIFT)
#endif

/* USB Clock Register PMC_USB */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_USB_USBS                   (1 << 0)  /* Bit 0:  USB Input Clock Selection */
#    define PMC_USB_USBS_PLLA            (0)
#    define PMC_USB_USBS_PLLB            PMC_USB_USBS
#  define PMC_USB_USBDIV_SHIFT           (8)       /* Bits 8-11: Divider for USB Clock */
#  define PMC_USB_USBDIV_MASK            (15 << PMC_USB_USBDIV_SHIFT)
#endif

/* PMC Master Clock Register */

#define PMC_MCKR_CSS_SHIFT               (0)       /* Bits 0-1: Master Clock Source Selection */
#define PMC_MCKR_CSS_MASK                (3 << PMC_MCKR_CSS_SHIFT)
#  define PMC_MCKR_CSS_SLOW              (0 << PMC_MCKR_CSS_SHIFT) /* Slow Clock */
#  define PMC_MCKR_CSS_MAIN              (1 << PMC_MCKR_CSS_SHIFT) /* Main Clock */
#  define PMC_MCKR_CSS_PLLA              (2 << PMC_MCKR_CSS_SHIFT) /* PLLA Clock */

#  if defined(CONFIG_ARCH_CHIP_SAM4S)
#    define PMC_MCKR_CSS_PLLB            (3 << PMC_MCKR_CSS_SHIFT) /* PLLB Clock */
#  elif defined(CONFIG_ARCH_CHIP_SAM3U) || defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A)
#    define PMC_MCKR_CSS_UPLL            (3 << PMC_MCKR_CSS_SHIFT) /* UPLL Clock */
#  endif

#define PMC_MCKR_PRES_SHIFT              (4)       /* Bits 4-6: Processor Clock Prescaler */
#define PMC_MCKR_PRES_MASK               (7 << PMC_MCKR_PRES_SHIFT)
#  define PMC_MCKR_PRES_DIV1             (0 << PMC_MCKR_PRES_SHIFT) /* Selected clock */
#  define PMC_MCKR_PRES_DIV2             (1 << PMC_MCKR_PRES_SHIFT) /* Selected clock divided by 2 */
#  define PMC_MCKR_PRES_DIV4             (2 << PMC_MCKR_PRES_SHIFT) /* Selected clock divided by 4 */
#  define PMC_MCKR_PRES_DIV8             (3 << PMC_MCKR_PRES_SHIFT) /* Selected clock divided by 8 */
#  define PMC_MCKR_PRES_DIV16            (4 << PMC_MCKR_PRES_SHIFT) /* Selected clock divided by 16 */
#  define PMC_MCKR_PRES_DIV32            (5 << PMC_MCKR_PRES_SHIFT) /* Selected clock divided by 32 */
#  define PMC_MCKR_PRES_DIV64            (6 << PMC_MCKR_PRES_SHIFT) /* Selected clock divided by 64 */
#  define PMC_MCKR_PRES_DIV3             (7 << PMC_MCKR_PRES_SHIFT) /* Selected clock divided by 3 */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_MCKR_PLLADIV2              (1 << 12) /* Bit 12: PLLA Divider */
#endif

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_MCKR_PLLBDIV2              (1 << 13) /* Bit 13: PLLB Divider */
#elif defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM3U)
#  define PMC_MCKR_UPLLDIV2              (1 << 13) /* Bit 13: UPLL Divider */
#endif

/* PMC Programmable Clock Register (0,1,2) */

#define PMC_PCK_CSS_SHIFT                (0)       /* Bits 0-2: Master Clock Source Selection */
#define PMC_PCK_CSS_MASK                 (7 << PMC_PCK_CSS_MASK)
#  define PMC_PCK_CSS_SLOW               (0 << PMC_PCK_CSS_MASK) /* Slow Clock */
#  define PMC_PCK_CSS_MAIN               (1 << PMC_PCK_CSS_MASK) /* Main Clock */
#  define PMC_PCK_CSS_PLLA               (2 << PMC_PCK_CSS_MASK) /* PLLA Clock */

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_PCK_CSS_PLLB               (3 << PMC_PCK_CSS_MASK) /* PLLB Clock */
#elif defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM3U)
#  define PMC_PCK_CSS_UPLL               (3 << PMC_PCK_CSS_MASK) /* UPLL Clock */
#endif

#  define PMC_PCK_CSS_MCK                (4 << PMC_PCK_CSS_MASK) /* Master Clock */

#define PMC_PCK_PRES_SHIFT               (4)       /* Bits 4-6: Programmable Clock Prescaler */
#define PMC_PCK_PRES_MASK                (7 << PMC_PCK_PRES_SHIFT)
#  define PMC_PCK_PRES_DIV1              (0 << PMC_PCK_PRES_SHIFT) /* Selected clock */
#  define PMC_PCK_PRES_DIV2              (1 << PMC_PCK_PRES_SHIFT) /* Selected clock divided by 2 */
#  define PMC_PCK_PRES_DIV4              (2 << PMC_PCK_PRES_SHIFT) /* Selected clock divided by 4 */
#  define PMC_PCK_PRES_DIV8              (3 << PMC_PCK_PRES_SHIFT) /* Selected clock divided by 8 */
#  define PMC_PCK_PRES_DIV16             (4 << PMC_PCK_PRES_SHIFT) /* Selected clock divided by 16 */
#  define PMC_PCK_PRES_DIV32             (5 << PMC_PCK_PRES_SHIFT) /* Selected clock divided by 32 */
#  define PMC_PCK_PRES_DIV64             (6 << PMC_PCK_PRES_SHIFT) /* Selected clock divided by 64 */

/* PMC Interrupt Enable Register, PMC Interrupt Disable Register, PMC Status Register,
 * and PMC Interrupt Mask Register common bit-field definitions
 */

#define PMC_INT_MOSCXTS                  (1 << 0)  /* Bit 0:  Main Crystal Oscillator Status Interrupt */
#define PMC_INT_LOCKA                    (1 << 1)  /* Bit 1:  PLL A Lock Interrupt */

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_INT_LOCKB                  (1 << 2)  /* Bit 2:  PLL B Lock Interrupt */
#endif

#define PMC_INT_MCKRDY                   (1 << 3)  /* Bit 3:  Master Clock Ready Interrupt */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM3U)
#  define PMC_INT_LOCKU                  (1 << 6)  /* Bit 6:  UTMI PLL Lock Interrupt */
#endif

#define PMC_SR_OSCSELS                   (1 << 7)  /* Bit 7:  Slow Clock Oscillator Selection (SR only) */
#define PMC_INT_PCKRDY(n)                (1 << ((n)+8)
#define PMC_INT_PCKRDY0                  (1 << 8)  /* Bit 8:  Programmable Clock Ready 0 Interrupt */
#define PMC_INT_PCKRDY1                  (1 << 9)  /* Bit 9:  Programmable Clock Ready 1 Interrupt */
#define PMC_INT_PCKRDY2                  (1 << 10) /* Bit 10: Programmable Clock Ready 2 Interrupt */
#define PMC_INT_MOSCSELS                 (1 << 16) /* Bit 16: Main Oscillator Selection Status Interrupt */
#define PMC_INT_MOSCRCS                  (1 << 17) /* Bit 17: Main On-Chip RC Status Interrupt */
#define PMC_INT_CFDEV                    (1 << 18) /* Bit 18: Clock Failure Detector Event Interrupt */
#define PMC_SR_CFDS                      (1 << 19) /* Bit 19: Clock Failure Detector Status (SR only) */
#define PMC_SR_FOS                       (1 << 20) /* Bit 20: Clock Failure Detector Fault Output Status (SR only) */

/* PMC Fast Startup Mode Register and PMC Fast Startup Polarity Register common bit-field
 * definitions
 */

#define PMC_FSTI(n)                      (1 << (n))
#define PMC_FSTI0                        (1 << 0)  /* Bit 0:  Fast Startup Input 0 */
#define PMC_FSTI1                        (1 << 1)  /* Bit 1:  Fast Startup Input 1 */
#define PMC_FSTI2                        (1 << 2)  /* Bit 2:  Fast Startup Input 2 */
#define PMC_FSTI3                        (1 << 3)  /* Bit 3:  Fast Startup Input 3 */
#define PMC_FSTI4                        (1 << 4)  /* Bit 4:  Fast Startup Input 4 */
#define PMC_FSTI5                        (1 << 5)  /* Bit 5:  Fast Startup Input 5 */
#define PMC_FSTI6                        (1 << 6)  /* Bit 6:  Fast Startup Input 6 */
#define PMC_FSTI7                        (1 << 7)  /* Bit 7:  Fast Startup Input 7 */
#define PMC_FSTI8                        (1 << 8)  /* Bit 8:  Fast Startup Input 8 */
#define PMC_FSTI9                        (1 << 9)  /* Bit 9:  Fast Startup Input 9 */
#define PMC_FSTI10                       (1 << 10) /* Bit 10: Fast Startup Input 10 */
#define PMC_FSTI11                       (1 << 11) /* Bit 11: Fast Startup Input 11 */
#define PMC_FSTI12                       (1 << 12) /* Bit 12: Fast Startup Input 12 */
#define PMC_FSTI13                       (1 << 13) /* Bit 13: Fast Startup Input 13 */
#define PMC_FSTI14                       (1 << 14) /* Bit 14: Fast Startup Input 14 */
#define PMC_FSTI15                       (1 << 15) /* Bit 15: Fast Startup Input 15 */
#define PMC_FSMR_RTTAL                   (1 << 16) /* Bit 16: RTT Alarm Enable (MR only) */
#define PMC_FSMR_RTCAL                   (1 << 17) /* Bit 17: RTC Alarm Enable (MR only) */
#define PMC_FSMR_USBAL                   (1 << 18) /* Bit 18: USB Alarm Enable (MR only) */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A) || defined(CONFIG_ARCH_CHIP_SAM3U)
#  define PMC_FSMR_LPM                   (1 << 20) /* Bit 20: Low Power Mode (MR only) */
#elif defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_FSMR_FLPM_SHIFT            (21)      /* Bit 21-22: Low Power Mode (MR only) */
#  define PMC_FSMR_FLPM_MASK             (3 << PMC_FSMR_FLPM_SHIFT)
#  define PMC_FSMR_FLPM_PWRDOWN          (0 << PMC_FSMR_FLPM_SHIFT) /* Flash Standby Mode */
#  define PMC_FSMR_FLPM_STANDBY          (1 << PMC_FSMR_FLPM_SHIFT) /* Flash deep power down mode */
#  define PMC_FSMR_FLPM_IDLE             (2 << PMC_FSMR_FLPM_SHIFT) /* Idle mode */
#endif

/* Fast Startup Polarity Register */

#define PMC_FSTP(n)                      (1 << (n)) /* Fast Startup Input Polarityn, n=0..15 */

/* PMC Fault Output Clear Register */

#define PMC_FOCLR                        (1 << 0)  /* Bit 0:  Fault Output Clear */

/* PMC Write Protect Mode Register */

#define PMC_WPMR_WPEN                    (1 << 0)  /* Bit 0:  Write Protect Enable */
#define PMC_WPMR_WPKEY_SHIFT             (8)       /* Bits 8-31: Write Protect KEY */
#define PMC_WPMR_WPKEY_MASK              (0x00ffffff << PMC_WPMR_WPKEY_SHIFT)
#  define PMC_WPMR_WPKEY                 (0x00504d43 << PMC_WPMR_WPKEY_SHIFT)

/* PMC Write Protect Status Register */

#define PMC_WPSR_WPVS                    (1 << 0)  /* Bit 0:  Write Protect Violation Status */
#define PMC_WPSR_WPVSRC_SHIFT            (8)       /* Bits 8-23: Write Protect Violation Source */
#define PMC_WPSR_WPVSRC_MASK             (0xffff << PMC_WPSR_WPVSRC_SHIFT)

/* Peripheral Clock Enable Register 1 */
/* Peripheral Clock Disable Register 1 */
/* Peripheral Clock Status Register 1 */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_PIDH(n)                    (1 << ((n) - 32))
#  define PMC_PID32                      (1 << 0)  /* Bit 0:  PID32 */
#  define PMC_PID33                      (1 << 1)  /* Bit 1:  PID33 */
#  define PMC_PID34                      (1 << 2)  /* Bit 2:  PID34 */
#  if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3X)
#    define PMC_PID35                    (1 << 3)  /* Bit 3:  PID35 */
#    define PMC_PID36                    (1 << 4)  /* Bit 4:  PID36 */
#    define PMC_PID37                    (1 << 5)  /* Bit 5:  PID37 */
#    define PMC_PID38                    (1 << 6)  /* Bit 6:  PID38 */
#    define PMC_PID39                    (1 << 7)  /* Bit 7:  PID39 */
#    define PMC_PID40                    (1 << 8)  /* Bit 8:  PID40 */
#    define PMC_PID41                    (1 << 9)  /* Bit 9:  PID41 */
#    define PMC_PID42                    (1 << 10) /* Bit 10: PID42 */
#    define PMC_PID43                    (1 << 11) /* Bit 11: PID43 */
#    define PMC_PID44                    (1 << 12) /* Bit 12: PID44 */
#  endif
#endif

/* Peripheral Control Register */

#if defined(CONFIG_ARCH_CHIP_SAM3X) || defined(CONFIG_ARCH_CHIP_SAM3A)
#  define PMC_PCR_PID_SHIFT              (0)       /* Bits 0-5: Peripheral ID */
#  define PMC_PCR_PID_MASK               (63 < PMC_PCR_PID_SHIFT)
#  define PMC_PCR_CMD                    (1 << 12) /* Bit 12: Command */
#  define PMC_PCR_DIV_SHIFT              (16)      /* Bits 16-17: Divisor Value */
#  define PMC_PCR_DIV_MASK               (3 < PMC_PCR_DIV_SHIFT)
#    define PMC_PCR_DIV1                 (0 < PMC_PCR_DIV_SHIFT) /* Peripheral clock is MCK */
#    define PMC_PCR_DIV2                 (1 < PMC_PCR_DIV_SHIFT) /* Peripheral clock is MCK/2 */
#    define PMC_PCR_DIV4                 (2 < PMC_PCR_DIV_SHIFT) /* Peripheral clock is MCK/4 */
#  define PMC_PCR_EN                     (1 << 28) /* Bit 28: Enable */
#endif

/* Oscillator Calibration Register */

#if defined(CONFIG_ARCH_CHIP_SAM4S)
#  define PMC_OCR_CAL4_SHIFT            (0)       /* Bits 0-6: 4MHzRC Oscillator Calibration */
#  define PMC_OCR_CAL4_MASK             (0x7f << PMC_OCR_CAL4_SHIFT)
#  define PMC_OCR_SEL4                  (1 << 7)  /* Bit 7:  Select 4MHz RC Oscillator Calibration */
#  define PMC_OCR_CAL8_SHIFT            (8)       /* Bits 8-14: 8MHzRC Oscillator Calibration */
#  define PMC_OCR_CAL8_MASK             (0x7f << PMC_OCR_CAL8_SHIFT)
#  define PMC_OCR_SEL8                  (1 << 15) /* Bit 15: Select 8MHz RC Oscillator Calibration */
#  define PMC_OCR_CAL12_SHIFT           (16)      /* Bits 16-22: 12MHzRC Oscillator Calibration */
#  define PMC_OCR_CAL12_MASK            (0x7f << PMC_OCR_CAL12_SHIFT)
#  define PMC_OCR_SEL12                 (1 << 23) /* Bit 23:  Select 12MHz RC Oscillator Calibration */
#endif

/********************************************************************************************
 * Public Types
 ********************************************************************************************/

/********************************************************************************************
 * Public Data
 ********************************************************************************************/

/********************************************************************************************
 * Public Functions
 ********************************************************************************************/

#endif /* __ARCH_ARM_SRC_SAM34_CHIP_SAM_PMC_H */