Contents
Previous Chapter
Next Chapter

---

1.1 Additional Documents

1. CyanIDE V2.x User Manual
2. CyanIDE V2.x C-Compiler User Manual
3. CyanIDE V2.x eCOG1X Assembler User Manual

1.2 Typographical Conventions

bold	Indicates an internal signal.
bold_italic	Indicates the name of a register.
bold_italic.dot	Indicates the name of a register field or a bit within a register. There may be several items separated by dots with each item containing items to its right and being contained by items to its left.
0x or H' prefix	Indicates a hexadecimal number. Examples: 0xFF (= 255 decimal), H'0A (= 10 decimal).
Single quotes or b suffix	Indicates a binary number. Examples: 1000b (= 8 decimal), '11' (= 3 decimal).

Notes within this document are used to highlight related or additional information to the user which is of interest or can prevent incorrect or undesirable operation. These notes are identified by the symbol shown on the left of this paragraph.

1.3 Part Identification

In this document any reference to eCOG1X means the generic chip and is applicable to all versions. All eCOG1X devices are suffixed according to their version. Any reference to a particular device such as eCOG1X0A5 is specific to that version.

1.4 Glossary

Table 1: Glossary

ACI	Analogue Control Interface
ADC	Analogue to Digital Converter
CAP	Capture Timer
CNT	General Purpose Counter/Timer
CPU	Central Processing Unit
CS	Chip Select
CSR	Control/Status Register
DMA	Direct Memory Access
DSCI	Dual Smart Card Interface
DUART	Dual UART
DUSART	Dual USART
EHI	External Host Interface
EMAC	Ethernet Media Access Controller
EMI	External Memory Interface
ESPI	Enhanced SPI
FIFO	First-In First-Out buffer (queue)
GPIO	General Purpose I/O
I2C	Inter-IC Communications
I2S	Inter-IC Sound
IFR	Infra-Red
I/O	Input/Output
IRQ	Interrupt Request
ISR	Interrupt Service Routine
LCD	Liquid Crystal Display
LIFO	Last-In First-Out buffer (stack)
LTMR	Long Interval Timer
MCPWM	Motor Control PWM
MII	Media Independent Interface
MISO	Master In Slave Out
MOSI	Master Out Slave In
MMP	Memory Mapped Peripheral
MMU	Memory Management Unit
OTG	On-The-Go (USB)
PHY	Physical layer transceiver device
PLL	Phase Locked Loop
PWM	Pulse Width Modulation Timer
RAM	Random Access Memory
ROM	Read Only Memory
RTC	Real Time Clock
RXD	Receive Data
SCI	Smart Card Interface
SCL	Serial Clock (I2C)
SDA	Serial Data (I2C)
SDRAM	Synchronous Dynamic RAM
SPI	Serial Peripheral Interface
SRAM	Static RAM
SSM	System Support Module
TIM	Timer/Counter Module
TMR	General Purpose Timer
TXD	Transmit Data
UART	Universal Asynchronous Receiver/Transmitter
ULPI	USB Low Pin count Interface
USART	Universal Synchronous/Asynchronous Receiver/Transmitter
USB	Universal Serial Bus
USR	User Serial Port
VCO	Voltage Controlled Oscillator
WDOG	Watchdog Timer

1.5 Registers and Bit Fields

The on-chip I/O registers may be accessed as complete registers, or as named bit fields within the registers. The CyanIDE development tools provide the include file registers.h which contains structure definitions for all on-chip registers and bit fields, and mask symbols for use within the registers. To access any register, use the structure prefix rg. To access a bit field within a register, use the structure prefix fd. For example:

// Write to baud rate register
rg.duart1.a_baud = 0xA55A;

// Write to data size bit field in frame configuration register
fd.duart1.frame_cfg.a_data_size = 0;

This convention for accessing the peripheral registers is used in all the source code examples in this document.

Note that using the fd prefix to access bit fields within the registers generates a read-modify-write code sequence, which reads the complete register, modifies the selected bits, then writes the modified data back to the complete register. In some circumstances it may be preferable to avoid the read-modify-write sequence by writing explicitly a bit pattern value to the complete register.

1.6 Disclaimer

This product is not designed or intended to be used for on-line control of aircraft, aircraft navigation or communications systems or in air traffic control applications or in the design, construction, operation or maintenance of any nuclear facility, or for any medical use related to life support equipment or systems intended to be surgically implanted into the body or any other life-critical application, whose failure to perform per documented instructions, can be reasonably expected to cause loss of life or significant injury. Cyan specifically disclaims any express or implied warranty of fitness for any or all of such uses.