Altera SoCAL  16.0
The Altera SoC Abstraction Layer (SoCAL) API Reference Manual
 All Data Structures Variables Typedefs Groups
Register : Main PLL VCO Advanced Control Register - misc

Description

Contains VCO control signals and other PLL control signals need to be controllable through register.

Fields are only reset by a cold reset.

Register Layout

Bits Access Reset Description
[0] RW 0x0 Loop Bandwidth Adjust Enabled
[12:1] RW 0x1 Loop Bandwidth Adjust
[13] RW 0x0 Fast Locking Enable
[14] RW 0x1 Saturation Enable
[31:15] ??? 0x0 UNDEFINED

Field : Loop Bandwidth Adjust Enabled - bwadjen

If set to 1, the Loop Bandwidth Adjust value comes from the Loop Bandwidth Adjust field.

If set to 0, the Loop Bandwidth Adjust value equals the M field divided by 2 value of the VCO Control Register. The M divided by 2 is the upper 12 bits (12:1) of the M field in the VCO register.

Field Access Macros:

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_LSB   0
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_MSB   0
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_WIDTH   1
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_SET_MSK   0x00000001
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_CLR_MSK   0xfffffffe
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_RESET   0x0
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_GET(value)   (((value) & 0x00000001) >> 0)
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_SET(value)   (((value) << 0) & 0x00000001)
 

Field : Loop Bandwidth Adjust - bwadj

Provides Loop Bandwidth Adjust value.

Field Access Macros:

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_LSB   1
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_MSB   12
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_WIDTH   12
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_SET_MSK   0x00001ffe
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_CLR_MSK   0xffffe001
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_RESET   0x1
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_GET(value)   (((value) & 0x00001ffe) >> 1)
 
#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_SET(value)   (((value) << 1) & 0x00001ffe)
 

Field : Fast Locking Enable - fasten

Enables fast locking circuit.

Field Access Macros:

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_LSB   13
 
#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_MSB   13
 
#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_WIDTH   1
 
#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_SET_MSK   0x00002000
 
#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_CLR_MSK   0xffffdfff
 
#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_RESET   0x0
 
#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_GET(value)   (((value) & 0x00002000) >> 13)
 
#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_SET(value)   (((value) << 13) & 0x00002000)
 

Field : Saturation Enable - saten

Enables saturation behavior.

Field Access Macros:

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_LSB   14
 
#define ALT_CLKMGR_MAINPLL_MISC_SATEN_MSB   14
 
#define ALT_CLKMGR_MAINPLL_MISC_SATEN_WIDTH   1
 
#define ALT_CLKMGR_MAINPLL_MISC_SATEN_SET_MSK   0x00004000
 
#define ALT_CLKMGR_MAINPLL_MISC_SATEN_CLR_MSK   0xffffbfff
 
#define ALT_CLKMGR_MAINPLL_MISC_SATEN_RESET   0x1
 
#define ALT_CLKMGR_MAINPLL_MISC_SATEN_GET(value)   (((value) & 0x00004000) >> 14)
 
#define ALT_CLKMGR_MAINPLL_MISC_SATEN_SET(value)   (((value) << 14) & 0x00004000)
 

Data Structures

struct  ALT_CLKMGR_MAINPLL_MISC_s
 

Macros

#define ALT_CLKMGR_MAINPLL_MISC_OFST   0x4
 

Typedefs

typedef struct
ALT_CLKMGR_MAINPLL_MISC_s 
ALT_CLKMGR_MAINPLL_MISC_t
 

Data Structure Documentation

struct ALT_CLKMGR_MAINPLL_MISC_s

WARNING: The C register and register group struct declarations are provided for convenience and illustrative purposes. They should, however, be used with caution as the C language standard provides no guarantees about the alignment or atomicity of device memory accesses. The recommended practice for writing hardware drivers is to use the SoCAL access macros and alt_read_word() and alt_write_word() functions.

The struct declaration for register ALT_CLKMGR_MAINPLL_MISC.

Data Fields
uint32_t bwadjen: 1 Loop Bandwidth Adjust Enabled
uint32_t bwadj: 12 Loop Bandwidth Adjust
uint32_t fasten: 1 Fast Locking Enable
uint32_t saten: 1 Saturation Enable
uint32_t __pad0__: 17 UNDEFINED

Macro Definitions

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_LSB   0

The Least Significant Bit (LSB) position of the ALT_CLKMGR_MAINPLL_MISC_BWADJEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_MSB   0

The Most Significant Bit (MSB) position of the ALT_CLKMGR_MAINPLL_MISC_BWADJEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_WIDTH   1

The width in bits of the ALT_CLKMGR_MAINPLL_MISC_BWADJEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_SET_MSK   0x00000001

The mask used to set the ALT_CLKMGR_MAINPLL_MISC_BWADJEN register field value.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_CLR_MSK   0xfffffffe

The mask used to clear the ALT_CLKMGR_MAINPLL_MISC_BWADJEN register field value.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_RESET   0x0

The reset value of the ALT_CLKMGR_MAINPLL_MISC_BWADJEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_GET (   value)    (((value) & 0x00000001) >> 0)

Extracts the ALT_CLKMGR_MAINPLL_MISC_BWADJEN field value from a register.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJEN_SET (   value)    (((value) << 0) & 0x00000001)

Produces a ALT_CLKMGR_MAINPLL_MISC_BWADJEN register field value suitable for setting the register.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_LSB   1

The Least Significant Bit (LSB) position of the ALT_CLKMGR_MAINPLL_MISC_BWADJ register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_MSB   12

The Most Significant Bit (MSB) position of the ALT_CLKMGR_MAINPLL_MISC_BWADJ register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_WIDTH   12

The width in bits of the ALT_CLKMGR_MAINPLL_MISC_BWADJ register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_SET_MSK   0x00001ffe

The mask used to set the ALT_CLKMGR_MAINPLL_MISC_BWADJ register field value.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_CLR_MSK   0xffffe001

The mask used to clear the ALT_CLKMGR_MAINPLL_MISC_BWADJ register field value.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_RESET   0x1

The reset value of the ALT_CLKMGR_MAINPLL_MISC_BWADJ register field.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_GET (   value)    (((value) & 0x00001ffe) >> 1)

Extracts the ALT_CLKMGR_MAINPLL_MISC_BWADJ field value from a register.

#define ALT_CLKMGR_MAINPLL_MISC_BWADJ_SET (   value)    (((value) << 1) & 0x00001ffe)

Produces a ALT_CLKMGR_MAINPLL_MISC_BWADJ register field value suitable for setting the register.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_LSB   13

The Least Significant Bit (LSB) position of the ALT_CLKMGR_MAINPLL_MISC_FASTEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_MSB   13

The Most Significant Bit (MSB) position of the ALT_CLKMGR_MAINPLL_MISC_FASTEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_WIDTH   1

The width in bits of the ALT_CLKMGR_MAINPLL_MISC_FASTEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_SET_MSK   0x00002000

The mask used to set the ALT_CLKMGR_MAINPLL_MISC_FASTEN register field value.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_CLR_MSK   0xffffdfff

The mask used to clear the ALT_CLKMGR_MAINPLL_MISC_FASTEN register field value.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_RESET   0x0

The reset value of the ALT_CLKMGR_MAINPLL_MISC_FASTEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_GET (   value)    (((value) & 0x00002000) >> 13)

Extracts the ALT_CLKMGR_MAINPLL_MISC_FASTEN field value from a register.

#define ALT_CLKMGR_MAINPLL_MISC_FASTEN_SET (   value)    (((value) << 13) & 0x00002000)

Produces a ALT_CLKMGR_MAINPLL_MISC_FASTEN register field value suitable for setting the register.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_LSB   14

The Least Significant Bit (LSB) position of the ALT_CLKMGR_MAINPLL_MISC_SATEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_MSB   14

The Most Significant Bit (MSB) position of the ALT_CLKMGR_MAINPLL_MISC_SATEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_WIDTH   1

The width in bits of the ALT_CLKMGR_MAINPLL_MISC_SATEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_SET_MSK   0x00004000

The mask used to set the ALT_CLKMGR_MAINPLL_MISC_SATEN register field value.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_CLR_MSK   0xffffbfff

The mask used to clear the ALT_CLKMGR_MAINPLL_MISC_SATEN register field value.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_RESET   0x1

The reset value of the ALT_CLKMGR_MAINPLL_MISC_SATEN register field.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_GET (   value)    (((value) & 0x00004000) >> 14)

Extracts the ALT_CLKMGR_MAINPLL_MISC_SATEN field value from a register.

#define ALT_CLKMGR_MAINPLL_MISC_SATEN_SET (   value)    (((value) << 14) & 0x00004000)

Produces a ALT_CLKMGR_MAINPLL_MISC_SATEN register field value suitable for setting the register.

#define ALT_CLKMGR_MAINPLL_MISC_OFST   0x4

The byte offset of the ALT_CLKMGR_MAINPLL_MISC register from the beginning of the component.

Typedef Documentation

The typedef declaration for register ALT_CLKMGR_MAINPLL_MISC.