Home

avr-libc Reference Manual

1. Signal Name Description SIG_2WIRE_SERIAL 2 wire serial interface aka 1178C tm SIG_ADC ADC Conversion complete SIG_COMPARATOR Analog Comparator Interrupt SIG_EEPROM_READY Eeprom ready SIG_FPGA_INTERRUPTO SIG_FPGA_INTERRUPT1 SIG_FPGA_INTERRUPT2 SIG_FPGA_INTERRUPT3 SIG_FPGA_INTERRUPT4 SIG_FPGA_INTERRUPTS SIG_FPGA_INTERRUPT6 SIG_FPGA_INTERRUPT7 SIG_FPGA_INTERRUPT8 SIG_FPGA_INTERRUPT9 SIG_FPGA_INTERRUPT10 SIG_FPGA_INTERRUPT11 SIG_FPGA_INTERRUPT12 SIG_FPGA_INTERRUPT13 SIG_FPGA_INTERRUPT14 SIG_FPGA_INTERRUPT15 SIG_INPUT_CAPTURE1 Input Capture1 Interrupt SIG_INPUT_CAPTURE3 Input Capture3 Interrupt SIG_INTERRUPTO External Interrupt0 SIG_INTERRUPT1 External Interrupt1 SIG INTERRUPT2 External Interrupt2 SIG_INTERRUPT3 External Interrupt3 SIG _INTERRUPT4 External Interrupt4 SIG_INTERRUPTS5 External Interrupt5 SIG_INTERRUPT6 External Interrupt6 SIG_INTERRUPT7 External Interrupt7 SIG_LOUTPUT_COMPAREO Output Compare0 Interrupt SIG_OUTPUT_COMPAREIA Output Compare1 A Interrupt SIG_OUTPUT_COMPAREIB Output Compare B Interrupt SIG_OUTPUT_COMPAREIC Output Compare1 C Interrupt SIG_OUTPUT_COMPARE2 Output Compare Interrupt SIG_OUTPUT_COMPARE3A Output Compare3 A Interrupt SIG_OUTPUT_COMPARE3B Output Compare3 B Interrupt SIG_OUTPUT_COMPARE3C Output Compare3 C Interrupt SIG_OVERFLOWO Over
2. Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities Variant of random that stores the context in the user supplied variable located at ct x instead of a static library variable so the function becomes re entrant 5 15 4 22 void srand unsigned int _seed Pseudo random number generator seeding see rand 5 15 4 23 void srandom unsigned long __seed Pseudo random number generator seeding see random 5 15 4 24 double strtod const char x __nptr char xx __endptr The strtod function converts the initial portion of the string pointed to by nptr to double representation The expected form of the string is an optional plus or minus sign followed by a sequence of digits optionally containing a decimal point character optionally fol lowed by an exponent An exponent consists of an E or e followed by an optional plus or minus sign followed by a sequence of digits Leading white space characters in the string are skipped The strtod function returns the converted value if any If endptr is not NULL a pointer to the character after the last character used in the conversion is stored in the location referenced by endptr If no conversion is performed zero is returned and the value of npt Y is stored in the location referenced by endpt rr If the correct value would cause overflow plus or minus HUGE_VAL is returned ac cording to the sign o
3. 5 15 4 7 diy t div int num int _denom The div function computes the value num denom and returns the quotient and re mainder in a structure named div_t that contains two int members named quot and rem 5 15 4 8 char dtostre double _val char x __s unsigned char _prec unsigned char _flags The dtostre function converts the double value passed in val into an ASCII repre sentation that will be stored under s The caller is responsible for providing sufficient storage in s Conversion is done in the format d ddde177dd where there is one digit be fore the decimal point character and the number of digits after it is equal to the preci sion prec if the precision is zero no decimal point character appears If flags has the DTOSTRE UPPERCASE bit set the letter R rather than e will be used to introduce the exponent The exponent always contains two digits if the value is zero the exponent is 00 If flags has the DTOSTRE_ALWAYS_SIGN bit set a space character will be placed into the leading position for positive numbers If flags has the DTOSTRE_PLUS_SIGN bit set a plus sign will be used instead of a space character in this case Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 55 5 15 4 9 charx dtostrf double _val char _width char _prec char x _s The dtostrf function converts the double value passed in val into an ASCII repre sentationthat will
4. e funsigned bitfields Make any unqualified bitfield type unsigned By default they are signed e fshort enums Allocate to an enum type only as many bytes as it needs for the declared range of possible values Specifically the enum type will be equivalent to the smallest integer type which has enough room e fpack struct Pack all structure members together without holes 7 10 2 Options for the assembler avr as 7 10 2 1 Machine specific assembler options e mmcu architecture e mmcu MCU name avr as understands the same mmcu options as avr gcc By default avr2 is as sumed but this can be altered by using the appropriate ar ch pseudo instruction inside the assembler source file e mall opcodes Turns off opcode checking for the actual MCU type and allows any possible AVR opcode to be assembled e mno skip bug Don t emit a warning when trying to skip a 2 word instruction with a CPSE SBIC SBIS SBRC SBRS instruction Early AVR devices suffered from a hardware bug where these instructions could not be properly skipped e mno wrap For RJMP RCALL instructions don t allow the target address to wrap around for devices that have more than 8 KB of memory e gstabs Generate stabs debugging symbols for assembler source lines This enables avr gdb to trace through assembler source files This option must not be used when assembling sources that have been generated by the C compiler thes
5. defined __AVR_AT90S4433__ define OC1 PB1 define DDROC DDRB define OCR OCRI elif defined __AVR_AT90S4414__ defined __AVR_AT90S8515__ defined __AVR_AT90S4434__ defined __AVR_AT90S8535__ defined __AVR_ATmegal163__ T define OC1 PD5 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 145 define DDROC DDRD define OCR OCRIA else error Don t know what kind of MCU you are compiling for endif if defined COMI1 define XCOM11 COM11 elif defined COM1A1 define XCOM11 COM1A1 else error need either COMIA1 or COM11 endif enum UP DOWN volatile uint16_t pwm Note 1 volatile uint8_t direction SIGNAL SIG_OVERFLOW1 Note 2 void ioin switch direction Note 3 case UP if pwm 1023 direction DOWN break case DOWN if pwm 0 direction UP break OCR pwm Note 4 it void Note 5 tmrl is 10 bit PWM TCCRIA _BV PWM10 _BV PWM11 _BV XCOM11 tmrl running on full MCU clock TCCRIB _BV CS10 set PWM value to 0 OCR 0 enable OCI and PB2 as output DDROC _BV OC1 timer_enable_int _BV TOIE1 enable interrupts Gener ated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 146 sei int main void ioinit loop forever
6. eeprom_rb addr 5 3 2 Define Documentation 5 3 2 1 define EEGET var addr var eeprom_rb addr Read a byte from EEPROM 5 3 2 2 define EEPUT addr val eeprom_wb addr val Write a byte to EEPROM 5 3 2 3 define eeprom _is_ready bit is_clear EECR EEWE Returns 1 if EEPROM is ready for a new read write operation 0 if not 5 3 2 4 define eeprom_rb addr eeprom_read_byte uint8_t addr Deprecated Use eeprom_read_byte in new programs Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 4 AVR device specific IO definitions 12 5 3 2 5 define eeprom_rw addr eeprom_read_word uint16_t addr Deprecated Use eeprom_read_word in new programs 5 3 2 6 define eeprom wb addr val eeprom_write_byte uint8_t addr uint8 _t val Deprecated Use eeprom_write_byte in new programs 5 3 3 Function Documentation 5 3 3 1 void eeprom_read_block void x buf const void x addr size_t n Read a block of n bytes from EEPROM address addr to buf 5 3 3 2 uint8_t eeprom_read_byte const uint8_t x addr Read one byte from EEPROM address addr 5 3 3 3 uint16_t eeprom_read_word const uint16_t x addr Read one 16 bit word little endian from EEPROM address addr 5 3 3 4 void eeprom write block const void buf void x addr size_t n Write a block of n bytes to EEPROM address addr from buf 5 3 3 5 void eeprom_write_byte uint8_t x addr uint8_t val Write a byte val to E
7. for X conversions prepended to it 0 zero Zero padding For all conversions the converted value is padded on the left with zeros rather than blanks If a precision is given with a numeric conversion d i 0 u i x and X the 0 flag is ignored A negative field width flag the converted value is to be left adjusted on the field boundary The converted value is padded on the right with blanks rather than on the left with blanks or zeros A overrides a 0 if both are given space A blank should be left before a positive number produced by a signed conversion d or i A sign must always be placed before a number produced by a signed conversion A overrides a space if both are used Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities An optional decimal digit string specifying a minimum field width If the converted value has fewer characters than the field width it will be padded with spaces on the left or right if the left adjust173 ment flag has been given to fill out the field width e An optional precision in the form of a period followed by an optional digit string If the digit string is omitted the precision is taken as zero This gives the minimum number of digits to appear for d i 0 u x and X conversions or the maximum number of characters to be printed from a string for s conversions e Anoptional 1 length modifier that speci
8. be 6S owe ROE ewe ee AS Sow R Assembler Macros lt apa mpos R R Bk a Ae 8 C Spb Functions ee to VUSMEMANSCLJ seer Sek eee oA eed Eee eS Foul F FAA 7 5 4 Intodu nom e eos 6 Se E we Ae RE RT BS Internal vs external RAM 4 0 0 Tunables forimalloc lt lt lt saa o a e Implementation details lt secs e somo ee e e Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen CONTENTS 7 6 te 7 8 19 7 10 Hl Release Numbering and Methodology 118 7 6 1 Release Version Numbering Scheme 118 262 Release AVR LIBE 2 244 cee eee SR ES 119 Memory Sections wa ee ee R 121 ren The text Secon 6 2 hk vaze 122 Lia Ine data Secon lt ra cre ek Fs ee ee Re 122 Tia The Bes Section lt o s lt o rese he ae ee ew a 122 TILA THe eeprom Section s o sr ccr iarrar a a 122 rje The MOM Secom neee 122 TLO Ri Rioja 123 TII The Bam Sections ss so e sesope a uji o ae 124 7 7 8 Using Sections in Assembler Code 0 0 125 tae Using Sechonsim Code 24 4 38 dn ARS 125 Installing the GNU Tool Cham 5 ak pe ee eae 126 781 Required Tools gt a ro recreo 664848 RR ee ea 127 Toe Ophonal THO lt s cee ew See Ee GR eS 127 7 8 3 GNU Binutils for the AVR target 4 0 0 128 7 84 GCC forthe AVR target 2 0 a a cete deute 129 Goto ANREDE o as doe A es eR BOE Baca ORS 130 RSG UBP S S 131 rei e oepa a eee eee Oe ea 131 78 8 GDB for the AVR target gt o
9. 8 bit unsigned type Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 12 Mathematics 30 5 11 2 10 typedef uint16_t uintptr_t Unsigned pointer compatible type 5 12 Mathematics 5 12 1 Detailed Description include lt math h gt This header file declares basic mathematics constants and functions Note In order to access the functions delcared herein it is usually also required to addi tionally link against the library 1ibm a See also the related FAQ entry Defines define M_PI 3 141592653589793238462643 define M_SQRT2 1 41421356237309504880 16887 Functions double cos double _x _ATTR_CONST_ double fabs double __x _ATTR_CONST_ double fmod double __x double __y _ATTR_CONST_ double modf double __value double _iptr double sin double __x _ATTR_CONST_ double sqrt double _x _ATTR CONST__ double tan double __x _ATTR_CONST_ double floor double __x _ATTR CONST__ double ceil double __x __ATTR CONST__ double frexp double __value int __exp double Idexp double __x int _exp _ATTR_CONST__ double exp double _x _ATTR_CONST__ double cosh double _x _ATTR_CONST_ double sinh double __x _ATTR_CONST__ double tanh double _x _ ATTR CONST__ double acos double __x _ATTR_CONST_ double asin double _x _ATTR CONST__ double atan double __x _ATTR_CONST__ double atan2 double __y double _x _ATTR CONST__ double log double _x _ATTR CONST__ Generated on
10. AT90S2313P x LED5MM R2 D1 zi DI See note 7 Na GND PEREPPE BBE RREBE Figure 5 Schematic of circuit for demo project The source code is given in demo c For the sake of this example create a file called demo c containing this source code Some of the more important parts of the code are Note 1 The PWM is being used in 10 bit mode so we need a 16 bit variable to remember the current value Note 2 SIGNAL is a macro that marks the function as an interrupt routine In this case the function will get called when the timer overflows Setting up interrupts is explained in greater detail in Interrupts and Signals Note 3 This section determines the new value of the PWM Note 4 Here s where the newly computed value is loaded into the PWM register Since we are in an interrupt routine it is safe to use a 16 bit assignment to the register Outside of an interrupt the assignment should only be performed with interrupts disabled if there s a chance that an interrupt routine could also access this register or another register that uses TEMP see the appropriate FAQ entry Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 144 Note 5 This routine gets called after a reset It initializes the PWM and enables interrupts Note 6 The main loop of the program does nothing all the work is done by the interrupt routin
11. General WIES ew a eee ee 50 JAT Detailed Deseriphon lt e 24 62 esos oe d be o T 8 50 5 15 2 Define Documentation p se a ee we ee 52 5 15 3 Typedef Documentation oss lt recreere cruds 53 5 15 4 Function Documentation lt a a a a ae a 53 5 15 5 Variable Documentation ss c esp a o o a eee 60 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen CONTENTS ni SHINEE sa eee 61 5 16 1 Detaled Desoripinini lt e lt 4 244408 58 aba o 61 5 16 2 Function Documentation 2 04 lt s e 5544 ee Se BRS 62 5 17 Interrupts and Signals gt o oe 0 a ee RE 69 517 1 Detaled Description lt o s soose 2 4 6 624 eu Saws 69 3 17 2 Defme Documentation cce 24 4 sat aaco eee 9 RS 72 5 17 3 Function Documentation 0 73 5 18 Special f nction registers ee RRR 74 S18 Detailed Description e s s pes op A SS EE 74 5 18 2 Define Documentation 2 76 6 avr libc Data Structure Documentation 79 G1 T Steuet Referente lt lt ce ae GE ae Rs BH HR 79 61 1 Detailed Description lt s a e nwe ke ee ae 79 62 Idivt Struct Referenc on 2 aa ersi bedro de ttk 79 62 1 Detailed Description s os sacs terio e pr ee bes 79 7 avr libc Page Documentation 79 ZL A knovwledsments o soona aie ee AR e a o SO 79 7 2 avr libc and assembler programs nooo 80 V2 1 Introduction 22 ea o ew bb eee kE A Eee aS 80 7 2 2 Invoking the compiler o oc scoperti erer 81 Tad Example progi crece te i e EEDS E ER
12. The compiler might produce the following code ELI ld r24 Z inc r24 st Z r24 sei One easy solution to avoid clobbering register r24 is to make use of the special tem porary register __tmp_reg__ defined by the compiler asm volatile Veli Way ld _tmp_reg__ a0 HA HEH inc __tmp_reg__ TAR NSL st a0 __tmp_reg__ HNHH sei Mane e ptr The compiler is prepared to reload this register next time it uses it Another problem with the above code is that it should not be called in code sections where interrupts are disabled and should be kept disabled because it will enable interrupts at the end We may store the current status but then we need another register Again we can solve this without clobbering a fixed but let the compiler select it This could be done with the help of a local C variable uint8_t s asm volatile in 0 _ SREG__ NENE Lean n t ld _tmp_reg__ al TN ET inc __tmp_reg__ n t St Sal __tmp_reg__ RET out __SREG__ 0 n t amp r s e ptr Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 111 Now every thing seems correct but it isn t really The assembler code modifies the variable that ptr points to The compiler will not recognize this and may keep its value in any of the other registers Not only does the compiler work with the wrong value but the assembler code does too The C program may have modified th
13. Wrote d bytes n rv for a 0 a lt 296 printf s 04x a rv ee24xx_read_bytes a 16 b if rv lt 0 error if rv lt 16 printf warning short read d n rv a rv for x 0 x lt rv x printf 02x b x putchar n printf done n str Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 165 Note 1 The header file lt avr io h gt contains some macro definitions for symbolic con stants used in the TWI status register These definitions match the names used in the Atmel datasheet except that all names have been prefixed with TW_ Note 2 The clock is used in timer calculations done by the compiler for the UART baud rate and the TWI clock rate Note 3 The address assigned for the 24Cxx EEPROM consists of 1010 in the upper four bits The following three bits are normally available as slave sub addresses allow ing to operate more than one device of the same type on a single bus where the actual subaddress used for each device is configured by hardware strapping How ever since the next data packet following the device selection only allows for 8 bits that are used as an EEPROM address devices that require more than 8 address bits 24C04 and above steal subaddress bits and use them for the EEPROM cell ad dress bits 9 to 11 as required This example simply assumes all subaddress bits are
14. avr2 at90s8535 AVR_AT9088535__ avr2 at86rf401 _AVR_AT86RF401__ avr3 atmega103 _ AVR_ATmega103__ avr3 atmega603 _ AVR _ATmega603__ avr3 at43usb320 _AVR_AT43USB320__ avr3 at43usb355 _AVR_AT43USB355_ avr3 at76c711 AVR_AT76C711__ avr4 atmega8 _ AVR _ATmega8__ avr4 atmega8515 _AVR_ATmega8515__ avr4 atmega8535 _AVR_ATmega8535__ avr5 atmega 16 _ AVR_ATmegal16__ avr5 atmegal61 _ AVR_ATmegal161__ avr5 atmega162 _ AVR_ATmega162__ avr5 atmega163 _ AVR_ATmega163__ avr5 atmega 169 _ AVR_ATmega169__ avr5 atmega32 _ AVR_ATmega32__ avr5 atmega323 _AVR_ATmega323 __ avr5 atmega64 _ AVR_ATmega64__ avr5 atmega 128 _ AVR _ATmega128__ avr5 at94k _ AVR_AT94K__ e morderl e morder2 Change the order of register assignment The default is 124 r25 r18 r19 r20 r21 r22 r23 r30 r31 r26 r27 r28 r29 r17 r16 r15 r14 r13 r12 r11 r10 r9 r8 r7 r6 r5 r4 r3 r2 r0 rl Order 1 uses r18 r19 r20 r21 r22 r23 r24 r25 r30 r31 r26 r27 r28 r29 r17 r16 r15 r14 r13 r12 r11 r10 r9 r8 r7 r6 r5 r4 r3 r2 r0 rl Order 2 uses r25 r24 r23 r22 r21 r20 r19 r18 r30 r31 r26 r27 r28 r29 r17 r16 r15 r14 r13 r12 r11 r10 r9 r8 r7 r6 r5 r4 r3 r2 rl rU e mint8 Assume int to be an 8 bit integer Note that this is not really supported by avr libc so it should normally not be used The default is to use 16 bit integers Generated on Wed Nov 26 21 10 23 2003 for avr libc by Do
15. avr_math 33 Power Management and Sleep Modes 20 PRG_RDB avr_pgmspace 15 printf avr_stdio 43 printf_P avr_stdio 43 Program Space String Utilities 13 PSTR avr_pgmspace 16 pute avr_stdio 39 putchar avr_stdio 39 puts avr_stdio 43 puts_P avr_stdio 43 qsort avr_stdlib 56 rand avr_stdlib 56 RAND_MAX avr_stdlib 52 rand_r avr_stdlib 56 random avr_stdlib 57 RANDOM MAX avr_stdlib 52 random_r avr_stdlib 57 sbi avr_sfr 78 scanf avr_stdio 43 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 176 scanf_P avr_stdio 43 sei avr_interrupts 72 set_sleep_mode avr_sleep 21 setjmp longjmp 35 setjmp 35 Setjmp and Longjmp 34 SIGNAL avr_interrupts 72 sin avr_math 33 sinh avr_math 33 sleep_mode avr_sleep 21 SLEEP_MODE_ADC avr_sleep 21 SLEEP_MODE_EXT_STANDBY avr_sleep 21 SLEEP_MODE_IDLE avr_sleep 21 SLEEP_MODE_PWR_DOWN avr_sleep 21 SLEEP_MODE_PWR_SAVE avr_sleep 21 SLEEP_MODE_STANDBY avr_sleep 21 snprintf avr_stdio 43 snprintf_P avr_stdio 43 Special function registers 73 sprintf avr_stdio 44 sprintf_P avr_stdio 44 sqrt avr_math 33 square avr_math 33 srand avr_stdlib 57 srandom avr_stdlib 57 sscanf avr_stdio 44 sscanf_P avr_stdio 44 Standard IO facilities 36 stderr avr_stdio 39 stdin avr_stdio 40 stdout avr_stdio 40 strcasecmp avr_string 63 strcasecmp_P avr_pgmspace 16 strcat avr_strin
16. case TW_START OK but should not happen case TW_REP_START break case TW_MT_ARB_LOST goto begin default goto error send SLA R TWDR sla TW_READ TWCR _BV TWINT _BV TWEN clear interrupt to start transmission while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_MR_SLA_ACK break case TW_MR_SLA_NACK goto quit case TW_MR_ARB_LOST goto begin default goto error for twcr _BV TWINT _BV TWEN _BV TWEA Note 11 len gt 0 len if len 1 twcr _BV TWINT _BV TWEN send NAK this time TWCR twcr clear int to start transmission while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_MR_DATA_NACK len 0 force end of loop FALLTHROUGH case TW_MR_DATA_ACK buf TWDR rv break default goto error quit Note 12 TWCR _BV TWINT _BV TWSTO _BV TWEN send stop condition Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWD 161 return rv error rv 1 goto quit Write len bytes into EEPROM starting at eeaddr from buf This is a bit simpler than the previous function since both the address and the data bytes will be transfered in master transmitter mode thus no reselection of the device is necessary Howev
17. characters are not compared Returns The strstr function returns a pointer to the beginning of the substring or NULL if the substring is not found If s2 points to a string of zero length the function returns s1 5 16 2 25 char x strtok_r char x string const char x delim char xx last Parses the string s into tokens strtok_r parses the string s into tokens The first call to strtok_r should have string as its first argument Subsequent calls should have the first argument set to NULL If a token ends with a delimiter this delimiting character is overwritten with a 0 and a pointer to the next character is saved for the next call to strtok_r The delimiter string delim may be different for each call last is a user allocated charx pointer It must be the same while parsing the same string strtok_r is a reentrant version of strtok Returns The strtok_r function returns a pointer to the next token or NULL when no more tokens are found 5 16 2 26 char x strupr char x string Convert a string to upper case The strupr function will convert a string to upper case Only the lower case alphabetic characters a z are converted Non alphabetic characters will not be changed Returns The strupr function returns a pointer to the converted string The pointer is the same as that passed in since the operation is perform in place Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 17 Interrupts and S
18. define putc __c __stream fputc __c __stream The macro putc used to be a fast macro implementation with a functionality iden tical to fputc For space constraints in avr libc it is just an alias for fputc 5 14 2 6 define putchar __c fputc __c stdout The macro put char sends character c to stdout 5 14 2 7 define stderr __iob 2 Stream destined for error output Unless specifically assigned identical to stdout If stderr should point to another stream the result of another fdevopen must be explicitly assigned to it without closing the previous st derr since this would also close stdout 5 14 2 8 define stdin _iob 0 Stream that will be used as an input stream by the simplified functions that don t take a stream argument The first stream opened with read intent using fdevopen will be assigned to stdin 5 14 2 9 define stdout _iob 1 Stream that will be used as an output stream by the simplified functions that don t take a stream argument The first stream opened with write intent using fdevopen will be assigned to both stdin and stderr Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 41 5 14 3 Function Documentation 5 14 3 1 void clearerr FILE x __stream Clear the error and end of file flags of st ream 5 14 3 2 int fclose FILE x _ sfream This function closes st ream and disallows and further IO to and from it
19. instruction which will need one additional word of ROM Another side effect of optimzation is that variable usage is restricted to the area of code where it is actually used So if a variable was placed in a register at the beginning of some function this same register can be re used later on if the compiler notices that the first variable is no longer used inside that function even though the variable is still in lexical scope When trying to examine the variable in avr gdb the displayed result will then look garbled So in order to avoid these side effects optimization can be turned off while debugging However some of these optimizations might also have the side effect of uncovering bugs that would otherwise not be obvious so it must be noted that turning off opti mization can easily change the bug pattern In most cases you are better off leaving optimizations enabled while debugging Back to FAQ Index 7 3 12 How do I trace an assembler file in avr gdb When using the g compiler option avr gcc only generates line number and other debug information for C and C files that pass the compiler Functions that don t have line number information will be completely skipped by a single st ep command in gdb This includes functions linked from a standard library but by default also functions defined in an assembler source file since the g compiler switch does not apply to the assembler So in order to debug an assembler input
20. n is sent literally down to the device s put function If the device requires a carriage return r character to be sent before the linefeed its put routine must implement this see note 2 For convenience the first call to fdevopen that opens a stream for reading will cause the resulting stream to be aliased to stdin Likewise the first call to fdevopen that opens a stream for writing will cause the resulting stream to be aliased to both stdout and stderr Thus if the open was done with both read and write intent all three standard streams will be identical Note that these aliases are indistinguishable from each other thus calling fclose on such a stream will also effectively close all of its aliases note 3 All the printf and scanf family functions come in two flavours the standard name where the format string is expected to be in SRAM as well as a version with the suffix P where the format string is expected to reside in the flash ROM The macro PSTR explained in Program Space String Utilities becomes very handy for declaring these format strings Note 1 It might have been possible to implement a device abstraction that is compatible with fopen but since this would have required to parse a string and to take all the information needed either out of this string or out of an additional table that would need to be provided by the application this approach was not taken Note 2 This basically fo
21. program are actually fairly complex which causes their inclusion to eat up Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 37 a fair amount of code space Also they are not fast due to the nature of interpreting the format string at run time Whenever possible resorting to the sometimes non standard predetermined conversion facilities that are offered by avr libc will usually cost much less in terms of speed and code size In order to allow programmers a code size vs functionality tradeoff the function vfprintf which is the heart of the printf family can be selected in different flavours using linker options See the documentation of vfprintf for a detailed description The same applies to vfscanf and the scanf family of functions The standard streams stdin stdout and stderr are provided but contrary to the C standard since avr libc has no knowledge about applicable devices these streams are not already pre initialized at application startup Also since there is no notion of file whatsoever to avr libc there is no function fopen that could be used to associate a stream to some device See note 1 Instead the function fdevopen is provided to associate a stream to a device where the device needs to provide a function to send a character to receive a character or both There is no differentiation between text and binary streams inside avr libc Character
22. 0 for the smaller devices so the EO E1 and E2 inputs of the 24Cxx must be grounded Note 4 This function is used by the standard output facilities that are utilized in this ex ample for debugging and demonstration purposes Note 5 In order to shorten the data to be sent over the TWI bus the 24Cxx EEPROMs support multiple data bytes transfered within a single request maintaining an in ternal address counter that is updated after each data byte transfered successfully When reading data one request can read the entire device memory if desired the counter would wrap around and start back from 0 when reaching the end of the device Note 6 When reading the EEPROM a first device selection must be made with write in tent R 172W bit set to 0 indicating a write operation in order to transfer the EEPROM address to start reading from This is called master transmitter mode Each completion of a particular step in TWI communication is indicated by an asserted TWINT bit in TWCR An interrupt would be generated if allowed Af ter performing any actions that are needed for the next communication step the interrupt condition must be manually cleared by setting the TWINT bit Unlike with many other interrupt sources this would even be required when using a true interrupt routine since as soon as TWINT is re asserted the next bus transaction will start Note 7 Since the TWI bus is multi master capable there is potential for a bus
23. 00800060 00800060 0000015e 2 0 ALLOC 3 noinit 00000000 00800063 00800063 0000015e 2 0 CONTENTS 4 eeprom 00000000 00810000 00810000 0000015e 2 0 CONTENTS 5 stab 00000684 00000000 00000000 00000160 2 2 CONTENTS READONLY DEBUGGING 6 stabstr 0000063d 00000000 00000000 000007e4 2 0 CONTENTS READONLY DEBUGGING Disassembly of section text 00000000 lt __vectors gt Oe Oa cO rjmp 20 O0x16 at 62 c0 rjmp 196 7 0xc8 4 61 co rjmp 194 Oxc8 6 60 c0 rjmp 192 Oxc8 8 5f cO rjmp 190 Oxc8 a Oa cO rjmp 20 0x20 5d c0 rjmp 186 Oxc8 e 5c co rjmp 184 Oxc8 0 5b c0 rjmp 182 Oxc8 2 Sa c0 rjmp 180 Oxc8 4 59 c0 rjmp 178 j 0x8 00000016 lt __ctors_end gt Grs 11 24 eor rl rl 8 1f be out Ox3f rl 63 a cf ed ldi r28 OxDF r 223 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 148 Te cd bf out Ox3d r28 le 4e c0 rjmp 156 00000020 lt __vector_5 gt volatile uint16_t pwm Note 1 volatile uint8_t direction SIGNAL SIG_OVERFLOW1 Note 2 203 1f 92 push rl 22 Of 92 push ro 24 Of b6 in r0 O0x3f 26 Of 92 push HO 28 11 24 eor tij ri 2a 2f 93 push r18 A 8f 93 push r24 2e 9f 93 push r25 switch direction Note 3 30 80 91 60 00 lds r24 0x0060 34 99 27 eor 25 r25 36 00 97 sbiw r24 0x00 38 al 0 breq 40 3a 01 97 sbiw r24 0x01 264 29 9 brne 74 case UP if pwm 1023
24. 10 23 2003 for avr libc by Doxygen 5 18 Special function registers 74 5 18 Special function registers 5 18 1 Detailed Description When working with microcontrollers many of the tasks usually consist of controlling the peripherals that are connected to the device respectively programming the subsys tems that are contained in the controller which by itself communicate with the circuitry connected to the controller The AVR series of microcontrollers offers two different paradigms to perform this task There s a separate IO address space available as it is known from some high level CISC CPUs that can be addressed with specific IO instructions that are applicable to some or all of the IO address space in out sbi etc The entire IO address space is also made available as memory mapped IO i e it can be accessed using all the MCU instructions that are applicable to normal data memory The IO register space is mapped into the data memory address space with an offset of 0x20 since the bottom of this space is reserved for direct access to the MCU registers Actual SRAM is available only behind the IO register area starting at either address 0x60 or 0x100 depending on the device AVR Libc supports both these paradigms While by default the implementation uses memory mapped IO access this is hidden from the programmer So the programmer can access IO registers either with a special function like outb include lt avr io
25. 5 How to modify MCUCR or WDTCR early The method of early initialization MCUCR WDTCR or anything else is different and more flexible in the current version Basically write a small assembler file which looks like this begin xram S Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions include lt avr io h gt section initl1 ax progbits idi r16 _BV SRE _BV SRW out _SFR_IO_ADDR MCUCR r16 end xram S Assemble it link the resulting xram o with other files in your program and this piece of code will be inserted in initialization code which is run right after reset See the linker script for comments about the new initN sections which one to use etc The advantage of this method is that you can insert any initialization code you want just remember that this is very early startup no stack and no _zero_reg__yet and no program memory space is wasted if this feature is not used There should be no need to modify linker scripts anymore except for some very spe cial cases It is best to leave __stack at its default value end of internal SRAM faster and required on some devices like ATmegal61 because of errata and add W1 Tdata 0x801100 to start the data section above the stack For more information on using sections including how to use them from C code see Memory Sections Back to FAQ Index 7 3 6 What is all this BV stuff about W
26. A constant describing the address of the last EEPROM cell FLASHEND A constant describing the last byte address in flash ROM SPM _PAGESIZE For devices with bootloader support the flash pagesize in bytes to be used for the SPM instruction 5 5 Program Space String Utilities 5 5 1 Detailed Description include lt avr io h gt include lt avr pgmspace h gt The functions in this module provide interfaces for a program to access data stored in program space flash memory of the device In order to use these functions the target device must support either the LPM or ELPM instructions Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 5 Program Space String Utilities Note These functions are an attempt to provide some compatibility with header files that come with IAR C to make porting applications between different compilers easier This is not 100 compatibility though GCC does not have full support for multiple address spaces yet Note If you are working with strings which are completely based in ram use the stan dard string functions described in Strings Note If possible put your constant tables in the lower 64K and use pgm_read_byte_ near or pgm_read_word_near instead of pgm read_byte_far or pgm_read_ word_far since it is more efficient that way and you can still use the upper 64K for executable code Backwards compatibility macros e define PRG_RDB addr pgm_read_byte
27. Doxygen 7 12 Example using the two wire interface TWD 162 break case TW_MT_ARB_LOST goto begin default return 1 error not in start condition NB do not send stop condition send SLA W TWDR sla TW_WRITE TWCR _BV TWINT _BV TWEN clear interrupt to start transmission while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_MT_SLA_ACK break case TW_MT_SLA_NACK nack during select device busy writing goto restart case TW_MT_ARB_LOST re arbitrate goto begin default goto error must send stop condition TWDR eeaddr low 8 bits of addr TWCR _BV TWINT _BV TWEN clear interrupt to start transmission while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_MT_DATA_ACK break case TW_MT_DATA_NACK goto quit case TW_MT_ARB_LOST goto begin default goto error must send stop condition for len gt 0 len TWDR buf TWCR _BV TWINT _BV TWEN start transmission while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_MT_DATA_NACK Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 163 goto error device write protected Note 14 case TW_MT_DATA_ACK rv break def
28. E 81 T3 Frequently Asked Questions 2 co ecca esera eere kawes 84 Tal PAINS oi acson LR 84 7 3 2 My program doesn t recognize a variable updated within an intermipt ro tin 422 ee og o ga og o a 85 7 3 3 I get undefined reference to for functions like sinQ 86 7 3 4 How to permanently bind a variable to a register 86 7 3 5 How to modify MCUCR or WDTCR early 86 7 3 6 What is all this _BV stuff about 87 73 7 CanluseC onthe AVR 2 2 ee RR es 88 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen CONTENTS iv 7 3 8 Tag 7 3 10 131 ele Fos 7 3 14 1312 7 3 16 dada 1318 Voda 7 3 20 44 21 E Why do some 16 bit timer registers sometimes get trashed How do I use a define d constant in an asm statement Why does the PC randomly jump around when single stepping How do I pass an IO port as a parameter to a function What registers are used by the C compiler My UART is generating nonsense My ATmegal28 keeps Why do all my foo bar strings eat up the SRAM Why does the compiler compile an 8 bit operation that uses How to detect RAM memory and variable overlap problems rE TIMEAS sadda a eH A de ee ee Oe 74 1 14 2 7 4 3 TAA 7 4 5 7 4 6 7 4 7 7 4 8 GCC asm Statement Assembler Code oo oe eee eS RRR ee Input and Output Operands s e 4 4 005 554 kaos KJODDEIE
29. Index Strings Interrupts and Signals Special function registers Additional notes from lt avr sfr_defs h gt 3 avr libc Data Structure Index 3 1 avr libc Data Structures Here are the data structures with brief descriptions div_t Idiv_t d avr libc Page Index 4 1 avr libc Related Pages Here is a list of all related documentation pages Acknowledgments avr libc and assembler programs Frequently Asked Questions Inline Asm Using malloc Release Numbering and Methodology Memory Sections Installing the GNU Tool Chain Using the avrdude program Using the GNU tools 61 69 74 19 79 79 79 80 84 102 114 118 121 126 133 134 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 avr libc Module Documentation A simple project 142 Example using the two wire interface TWI 154 Todo List 167 Deprecated List 167 5 avr libc Module Documentation 5 1 Bootloader Support Utilities 5 1 1 Detailed Description include lt avr io h gt include lt avr boot h gt The macros in this module provide a C language interface to the bootloader support functionality of certain AVR processors These macros are designed to work with all sizes of flash memory Note Not all AVR processors provide bootloader support See your processor datasheet to see if it provides bootloader support Todo From email with Marek On smaller devices all except ATmega64 128 SPM
30. Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 159 case TW_MT_ARB_LOST Note 7 goto begin default return 1 error not in start condition NB do not send stop condition Note 8 send SLA W TWDR sla TW_WRITE TWCR _BV TWINT _BV TWEN clear interrupt to start transmission while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_MT_SLA_ACK break case TW_MT_SLA_NACK nack during select device busy writing Note 9 goto restart case TW_MT_ARB_LOST re arbitrate goto begin default goto error must send stop condition TWDR eeaddr low 8 bits of addr TWCR _BV TWINT _BV TWEN clear interrupt to start transmission while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_MT_DATA_ACK break case TW_MT_DATA_NACK goto quit case TW MT ARB LOST goto begin default goto error must send stop condition Note 10 Next cycle s master receiver mode TWCR _BV TWINT _BV TWSTA _BV TWEN send rep start condition while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 160
31. O Every thing below here is used by avr libc s build system and by the casual user FIG2DEV EXTRA_CLEAN_FILES dox eps png pdf eps PRG eps png PRG png pdf PRG pdf eps fig FIG2DEV pdt fig FIG2DEV S png fig FIG2DEV 7 12 fig2dev hex bin srec L eps lt 29 L pdf lt 29 L png lt S Example using the two wire interface TWI ihex lt S srec lt binary lt 29 can be ignored Some newer devices of the ATmega series contain builtin support for interfacing the mi crocontroller to a two wire bus called TWI This is essentially the same called 1178C by Philips but that term is avoided in Atmel s documentation due to patenting issues For the original Philips documentation see http www semiconductors philips com buses i2c inde 7 12 1 Introduction into TWI The two wire interface consists of two signal lines named SDA serial data and SCL serial clock plus a ground line of course All devices participating in the bus are connected together using open drain driver circuitry so the wires must be terminated Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI using appropriate pullup resistors The pullups must be small enough to recharge the line capacity in short enough time compared to the desired maximal clock fre quency yet large enough so all drivers will
32. REG is in the I O space accessible with the shorter in and out instructions since the boot loader has a limited size this could be an important optimization API Usage Example The following code shows typical usage of the boot API include lt avr interrupt h gt include lt avr pgmspace h gt define ADDRESS Ox1C000UL void boot_test void unsigned char buffer 8 cli Erase page boot_page_erase unsigned long ADDRESS Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 1 Bootloader Support Utilities while boot_rww_busy boot_rww_enable Write data to buffer a word at a time Note incrementing address by 2 SPM_PAGESIZE is defined in the microprocessor IO header file for unsigned long i ADDRESS i lt ADDRESS SPM_PAGESIZE i 2 boot_page_fill i i ADDRESS i ADDRESS 1 lt lt 8 Write page boot_page_write unsigned long ADDRESS while boot_rww_busy boot_rww_enable sei Read back the values and display The show function is undefined and is used here as an example only for unsigned long i ADDRESS i lt ADDRESS 256 i show utoa pgm_read_byte i buffer 16 return Defines define BOOTLOADER_SECTION __attribute__ section bootloader define boot_spm_interrupt_enable _SPM_REG uint8_t _BV SPMIE define boot_spm_interrupt_disable _SPM_REG am
33. WDTO_15MS et al 5 8 2 3 define wdt_reset _asm__ __volatile__ wdr Reset the watchdog timer When the watchdog timer is enabled a call to this instruction is required before the timer expires otherwise a watchdog initiated device reset will occur 5 8 2 4 define WDTO_120MS 3 See WDTO_15MS Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 9 Character Operations 24 5 8 2 5 define WDTO_15MS 0 Symbolic constants for the watchdog timeout Since the watchdog timer is based on a free running RC oscillator the times are approximate only and apply to a supply voltage of 5 V At lower supply voltages the times will increase For older devices the times will be as large as three times when operating at Vcc 3 V while the newer devices e g ATmegal28 ATmega8 only experience a negligible change Possible timeout values are 15 ms 30 ms 60 ms 120 ms 250 ms 500 ms 1 s 2 s Symbolic constants are formed by the prefix WDTO_ followed by the time Example that would select a watchdog timer expiry of approximately 500 ms wdt_enable WDTO_500MS 5 8 2 6 define WDTO_1S 6 See WDTO_15MS 5 8 2 7 define WDTO_250MS 4 See WDTO_15MS 5 8 2 8 define WDTO_2S 7 See WDTO_15MS 5 8 2 9 define WDTO_30MS 1 See WDTO_15MS 5 8 2 10 define WDTO_500MS 5 See WDTO_15MS 5 8 2 11 define WDTO_60MS 2 WDTO_15MS 5 9 Character Operations 5 9 1 Detailed Description These functions pe
34. Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 12 Mathematics 31 double log10 double _x _ATTR CONST__ double pow double __x double _ y _ATTR_CONST__ int isnan double __x _ATTR_CONST_ int isinf double __x _ATTR_CONST_ double square double x _ATTR_CONST_ double inverse double __ATTR_CONST_ 5 12 2 Define Documentation 5 12 2 1 define M_PI 3 141592653589793238462643 The constant pi 5 12 2 2 define M_SQRT2 1 4142135623730950488016887 The square root of 2 5 12 3 Function Documentation 5 12 3 1 double acos double _x The acos function computes the principal value of the arc cosine of x The returned value is in the range 0 pi radians A domain error occurs for arguments not in the range 1 1 5 12 3 2 double asin double _x The asin function computes the principal value of the arc sine of x The returned value is in the range 0 pi radians A domain error occurs for arguments not in the range 1 1 5 12 3 3 double atan double __x The atan function computes the principal value of the arc tangent of x The returned value is in the range 0 pi radians A domain error occurs for arguments not in the range 1 1 5 12 3 4 double atan2 double __y double __x The atan2 function computes the principal value of the arc tangent of y x using the signs of both arguments to determine the quadrant of the return value The returned value is in the range pi pi radia
35. Why do some 16 bit timer registers sometimes get trashed Modules e Additional notes from lt avr sfr_defs h gt Bit manipulation e define BV bit 1 lt lt bit IO register bit manipulation define bit_is_set sfr bit sfr amp _BV bit define bit_is_clear sfr bit sfr amp _BV bit define loop_until_bit_is_set sfr bit do while bit_is_clear sfr bit define loop_until_bit_is_clear sfr bit do while bit_is_set sfr bit Deprecated Macros define cbi sfr bit SFR_BYTE sfr amp _BV bit define sbi sfr bit SFR_BYTE sfr _BV bit define inb sfr _SFR_BYTE sfr define outb sfr val _SFR_BYTE sfr val define inw sfr SFR WORD sfr define outw sfr val SSFR WORD sfr val define outp val sfr outb sfr val define inp sfr inb sfr define BV bit _BV bit Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 18 Special function registers 76 5 18 2 Define Documentation 5 18 2 1 define BV bit 1 lt lt bit include lt avr io h gt Converts a bit number into a byte value Note The bit shift is performed by the compiler which then inserts the result into the code Thus there is no run time overhead when using _BV 5 18 2 2 define bit_is_clear sfr bit sfr amp _BV bit include lt avr io h gt Test whether bit bit in IO register sfr is clear This will return non zero if the bit is clear and a 0 if the bit is
36. _BV PD7 Back to FAQ Index 7 3 7 Can I use C on the AVR Basically yes C is supported assuming your compiler has been configured and compiled to support it of course Source files ending in cc cpp or C will automat ically cause the compiler frontend to invoke the C compiler Alternatively the C compiler could be explicitly called by the name avr c However there s currently no support for libstdc the standard support library needed for a complete C implementation This imposes a number of restrictions on the C programs that can be compiled Among them are e Obviously none of the C related standard functions classes and template classes are available e The operators new and delete are not implemented attempting to use them will cause the linker to complain about undefined external references This could perhaps be fixed e Some of the supplied include files are not C safe i e they need to be wrapped into extern C a This could certainly be fixed too e Exceptions are not supported Since exceptions are enabled by default in the C frontend they explicitly need to be turned off using fno exceptions in the compiler options Failing this the linker will complain about an undefined external reference to _gxx_personality_sj0 Constructors and destructors are supported though including global ones When programming C in space and runtime sensitive environments like microcon
37. and assembler programs tmp EF inttmp 19 intsav 0 SQUARE PD6 Note 3 Note 4 tmconst 10700000 200000 100 kHz gt 200000 edges s fuzz 8 clocks in ISR until TCNTO is set section text global main Note 5 main rcall ioinit lg rjmp ib Note 6 global SIG_OVERFLOWO Note 7 SIG_OVERFLOWO ldi inttmp 256 tmconst fuzz out _SFR_IO_ADDR TCNTO inttmp Note 8 in intsav _SFR_IO_ADDR SREG Note 9 sbic _SFR_IO_ADDR PORTD SQUARE rjmp TE sbi _SFR_IO_ADDR PORTD SQUARE rjmp 2f 1 chi _SFR_IO_ADDR PORTD SQUARE out _SFR_IO_ADDR SREG intsav reti ioinit sbi _SFR_IO_ADDR DDRD SQUARE ldi work _BV TOIEO out _SFR_IO_ADDR TIMSK work Lai work _BV CS00 tmrO CK 1 out _SFR_IO_ADDR TCCRO work Tar work 256 tmconst out _SFR_IO_ADDR TCNTO work sei ret global __vector_default Note 10 __vector_default Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 2 avr libc and assembler programs reti end Note 1 As in C programs this includes the central processor specific file containing the IO port definitions for the device Note that not all include files can be included into assembler sources Note 2 Assignment of registers to symbolic names used locally Another option would be to use a C preprocessor macro instead define work 16 Note 3 Our bit number for the square wave output Note that the right
38. co ba ek eee So 131 29 T oon ee KR Se ee ee EOS ee a Res 132 KM UDI E 3 2 2 6 van ee ZA ta ewes hig dod cakes 132 Using the avrdude program 2 0 4 133 Using the GNU tools 2 ee ee i a ri pay 134 7 10 1 Options for the C compiler avr gcc 2 2 135 7 10 2 Options for the assembler avr as 0 0 0 139 7 10 3 Controlling the linker avr ld 0 0 0 140 A SMPS PIOJERE ced eee e he ee Bae E eee BE a 142 AILE TRS Project o srake Ce ee ee pok a ee e ee S 143 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 1 AVR Libc 7 112 The Sonte Code oos see eA eee o 144 711 3 Compiling and LINKING gt lt v zo o ko g Seed ae eee 146 T114 Examining the Object File o 205 K RR es 146 TILS Linker Map Piles 4 5 cea ea eee N E 150 TILO Intel Hex Piles oc a BS 152 LLL Make Build the Project lt lt lt 4 5 4 4 4s be eee de hes 152 7 12 Example using the two wire interface TWI 154 112 1 Introduction into TWL lt es 154 712 2 The TWL example project 2 occo op o a o raak 155 TAa The oda mome 155 re i 1 e 167 TA Deprecated List sce go Soe oe eS N Ae Se gl a i es 167 1 AVR Libe The latest version of this document is always available from http savannah nongnu org projects avr libc The AVR Libc package provides a subset of the standard C library for Atmel AVR 8 bit RISC microcontrollers In addition the library provides the basic startup code needed by mo
39. cvs tag avr libc 1_0_1 release 1 cvs tag avr libc 1_2 branchpoint set version to 1 3 0 lt date gt atn Cag E Se Gee ner set version to 1 1 90 lt date gt set version to 1 2 cvs tag avr libc 1_2 release cvs tag avr libc 2 0 branchpoint set version to 2 1 0 lt date gt Figure 4 Release tree 7 7 Memory Sections Remarks Need to list all the sections which are available to the avr Weak Bindings FIXME need to discuss the weak directive The following describes the various sections available Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 7 Memory Sections 122 7 7 1 The text Section The text section contains the actual machine instructions which make up your program This section is further subdivided by the initN and finiN sections dicussed below Note The avr size program part of binutils coming from a Unix background doesn t account for the data initialization space added to the text section so in order to know how much flash the final program will consume one needs to add the values for both text and data but not bss while the amount of pre allocated SRAM is the sum of data and bss 7 7 2 The data Section This section contains static data which was defined in your code Things like the fol lowing would end up in data char err_str Your program has died a horrible death struct point pt 1 1 It is possible to tell the
40. demo OBJ demo o MCU_TARGET at90s2313 OPTIMIZE 02 DEF S LIBS m You should not have to change anything below here GE avr gcc Override is only needed by avr lib build system override CFLAGS g Wall OPTIMIZE mmcu MCU_TARGET DEFS override LDFLAGS W1 Map PRG map OBJCOPY avr objcopy OBJDUMP avr objdump all PRG elf lst text eeprom S PRG elf OBJ CC CFLAGS LDFLAGS o LIBS clean rm rf o PRG elf eps png pdf bak rm rf 1lst map EXTRA_CLEAN_FILES lst PRG lst lst elf OBJDUMP h S lt gt Rules for building the text rom images text hex bin srec hex PRG hex bin PRG bin srec PRG srec S hex elf OBJCOPY j text j data O ihex lt 29 ole srec elf OBJCOPY j text j data O srec lt oo bin S elf OBJCOPY j text j data O binary lt Rules for building the eeprom rom images Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 154 eeprom ehex ebin esrec ehex ebin esrec PRG _eeprom hex PRG _eeprom bin PRG _eeprom srec S_eeprom hex elf OBJCOPY j eeprom change section lma eeprom 0 O S_eeprom srec elf OBJCOPY j eeprom change section lma eeprom 0 O S_eeprom bin elf S OBJCOPY j eeprom change section lma eeprom 0
41. files may produce com piler warnings if they are used in modules which are compiled in strict ANSI mode To avoid that you can write __asm__ instead of asm and _volatile__ instead of volatile These are equivalent aliases Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 112 Another problem with reused macros arises if you are using labels In such cases you may make use of the special pattern which is replaced by a unique number on each asm statement The following code had been taken from avr include iomacros h define loop_until_bit_is_clear port bit __asm__ _ volatile__ L_ sbic 0 1 n t rjmp L_ no outputs I gintB_t porti X I uint8_t bit When used for the first time L may be translated to L 1404 the next usage might create L_1405 or whatever In any case the labels became unique too 7 4 6 C Stub Functions Macro definitions will include the same assembler code whenever they are referenced This may not be acceptable for larger routines In this case you may define a C stub function containing nothing other than your assembler code void delay uint8_t ms uintl6_t cnt asm volatile n L Ali ave mov SA0 A2 n t mov B0 B2 n L dl Mait sbiw A0 1 n t brne L_dl2 n t dec 1 n t brne L_d11 n t amp w cnt ms me r delay_count i The purpose o
42. for environments that are tight on space This version is provided in the library 1ilbscanf_min a and can be requested using the following options in the link stage WI u vfscanf lscanf_min lm In addition to the restrictions of the standard version this version implements no field width specification no conversion assignment suppression flag no n specification Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 50 and no general format character matching at all All characters in fmt that do not comprise a conversion specification will simply be ignored including white space that is normally used to consume any amount of white space in the input stream However the usual skip of initial white space in the formats that support it is implemented 5 14 3 34 int vfscanf_P FILE _sfream const char gt _ fmt va_list __ap Variant of vfscanf using a fmt string in program memory 5 14 3 35 int vsnprintf char x _s size_t _n const char x _fmt va_list ap Like vsprintf but instead of assuming s to be of infinite size no more than n characters including the trailing NUL character will be converted to s Returns the number of characters that would have been written to s if there were enough space 5 14 3 36 int vsnprintf_P char x __s size_t _ const char __fmt va_list ap Variant of vsnprintf that uses a fmt string that resides in program memory 5 14 3 37 i
43. for the AVR target The binutils package provides all the low level utilities needed in building and ma nipulating object files Once installed your environment will have an AVR assembler avr as linker avr 1d and librarian avr ar and avr ranlib In addi tion you get tools which extract data from object files avr objcopy dissassem ble object file information avr objdump and strip information from object files avr strip Before we can build the C compiler these tools need to be in place Download and unpack the source files bunzip2 c binutils lt version gt tar bz2 tar xf cd binutils lt version gt Note Replace lt version gt with the version of the package you downloaded Note If you obtained a gzip compressed file gz use gunzip instead of bunzip2 It is usually a good idea to configure and build binutils in a subdirectory so as not to pollute the source with the compiled files This is recommended by the binutils developers Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 8 Installing the GNU Tool Chain 129 mkdir obj avr cd obj avr The next step is to configure and build the tools This is done by supplying arguments to the configure script that enable the AVR specific options configure prefix PREFIX target avr disable nls If you don t specify the prefix option the tools will get installed in the usr 1local hierarchy i e the
44. identical strings into a single one but obviously only for one compilation unit i e a single C source file That way any string literal will be a valid argument to any C function that expects a const char x argument Of course this is going to waste a lot of SRAM In Program Space String Utilities a method is described how such constant data can be moved out to flash ROM How ever a constant string located in flash ROM is no longer a valid argument to pass to a function that expects a const char x type string since the AVR processor needs the special instruction LPM to access these strings Thus separate functions are needed that take this into account Many of the standard C library functions have equivalents available where one of the string arguments can be located in flash ROM Private func tions in the applications need to handle this too For example the following can be used to implement simple debugging messages that will be sent through a UART include lt inttypes h gt Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 101 include lt avr io h gt include lt avr pgmspace h gt void uart_putchar char c if c n uart_putchar r loop_until_bit_is_set USR UDRE UDR c void debug_P const char addr Ghar Gi while c pgm_read_byte addr uart_putchar c int main void debug_P PSTR foo was here n
45. increment your address by 2 between calls and send 2 data bytes in a word format The LSB of the data is written to the lower address the MSB of the data is written to the higher address 5 1 2 5 define boot_page_write address __boot_page_write_normal address Write the bootloader temporary page buffer to flash page that contains address Note address is a byte address in flash not a word address 5 1 2 6 define boot_rww_busy _SPM_REG amp uint8_t _BV _COMMON_ ASB Check if the RWW section is busy Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 2 CRC Computations 5 1 2 7 define boot_rww_enable __boot_rww_enable Enable the Read While Write memory section 5 1 2 8 define boot_spm_busy _SPM_REG amp uint8_t _BV SPMEN Check if the SPM instruction is busy 5 1 2 9 define boot_spm_busy_wait do while boot_spm_busy Wait while the SPM instruction is busy 5 1 2 10 define boot_spm_interrupt_disable SPM REG amp uint8_t _ BV SPMIE Disable the SPM interrupt 5 1 2 11 define boot_spm_interrupt_enable SPM REG uint8_t _ BV SPMIE Enable the SPM interrupt 5 1 2 12 define BOOTLOADER SECTION _attribute__ section boot loader Used to declare a function or variable to be placed into a new section called boot loader This section and its contents can then be relocated to any address such as the bootloader NRWW area at link time 5 2 C
46. linker the SRAM address of the beginning of the data section This is accomplished by adding W1 Tdata addr to the avr gcc command used to the link your program Not that addr must be offset by adding 0x800000 the to real SRAM address so that the linker knows that the address is in the SRAM memory space Thus if you want the data section to start at 0x1100 pass 0x801100 at the address to the linker offset explained Note When using malloc in the application which could even happen inside library calls additional adjustments are required 7 7 3 The bss Section Uninitialized global or static variables end up in the bss section 7 7 4 The eeprom Section This is where eeprom variables are stored 7 7 5 The noinit Section This sections is a part of the bss section What makes the noinit section special is that variables which are defined as such Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 7 Memory Sections 123 int foo __attribute__ section noinit will not be initialized to zero during startup as would normal bss data Only uninitialized variables can be placed in the noinit section Thus the following code will cause avr gcc to issue an error int bar __attribute__ section noinit Oxaa It is possible to tell the linker explicitly where to place the noinit section by adding W1 section start noinit 0x802000 to the avr gcc command line at the linking st
47. new function that appears to have been entered Thus the best practice to avoid this confusion is to only use non local labels when declaring a new function and restrict anything else to local labels Local labels consist just of a number only References to these labels consist of the number followed by the letter b for a backward reference or f for a forward reference These local labels may be re used within the source file references will pick the closest label with the same number and given direction Example myfunc push r push r push r18 push YL push YH eor r16 rL6 start loop ldi YL lo8 sometable idi YH hi8 sometable rjmp 2f jump to loop test at end dis lda rl7 Y loop continues here breq 1f return from myfunc prematurely inc rl6 2 cmp 16 r18 belo 1b jump back to top of loop lis pop YH pop YL Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 93 pop r18 pop ELJ pop rig ret Back to FAQ Index 7 3 13 How do I pass an IO port as a parameter to a function Consider this example code include lt inttypes h gt include lt avr io h gt void set_bits_func_wrong volatile uint8_t port uint8_t mask port mask void set_bits_func_correct volatile uint8_t port uint8_t mask port mask define set_bits_macro port mask port mask int main void set_bits_func_wrong PORTB Oxaa set_bits_f
48. nmemb objects size bytes each to stream The first byte of the first object is referenced by ptr Returns the number of objects successfully written i e nmemb unless an output error occured 5 14 3 17 char gets char x _ str Similar to fgets except that it will operate on stream st din and the trailing newline if any will not be stored in the string It is the caller s responsibility to provide enough storage to hold the characters read 5 14 3 18 int printf const char x _ fmt The function printf performs formatted output to stream stderr See vfprintf for details 5 14 3 19 int printf P const char _fmit Variant of printf that uses a fmt string that resides in program memory 5 14 3 20 int puts const char _str Write the string pointed to by st r and a trailing newline character to stdout Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 44 5 14 3 21 int puts_P const char _str Variant of puts where str resides in program memory 5 14 3 22 int scanf const char __fmt The function scanf performs formatted input from stream st din See vfscanf for details 5 14 3 23 int scanf_P const char __fmt Variant of scanf where fmt resides in program memory 5 14 3 24 int snprintf char _s size_t _n const char _fmt Like sprintf but instead of assuming s to be of infinite size no more than n ch
49. not be overloaded There are formulas in the datasheet that help selecting the pullups Devices can either act as a master to the bus i e they initiate a transfer or as a slave they only act when being called by a master The bus is multi master capable and a particular device implementation can act as either master or slave at different times Devices are addressed using a 7 bit address coordinated by Philips transfered as the first byte after the so called start condition The LSB of that byte is R 172W i e it determines whether the request to the slave is to read or write data during the next cycles There is also an option to have devices using 10 bit addresses but that is not covered by this example 7 12 2 The TWI example project The ATmega TWI hardware supports both master and slave operation This example will only demonstrate how to use an AVR microcontroller as TWI master The imple mentation is kept simple in order to concentrate on the steps that are required to talk to a TWI slave so all processing is done in polled mode waiting for the TWI interface to indicate that the next processing step is due by setting the TWINT interrupt bit If it is desired to have the entire TWI communication happen in background all this can be implemented in an interrupt controlled way where only the start condition needs to be triggered from outside the interrupt routine There is a variety of slave devices available that can be
50. only This macro will eventually be removed Write the 16 bit value val to IO register pair sfr Care will be taken to write the lower register first When used to update 16 bit registers where the timing is critical and the operation can be interrupted the programmer is the responsible for disabling interrupts before accessing the register pair Use direct access in new programs Note The order of the arguments was switched in older versions of avr libc versions lt 20020203 5 18 2 12 define sbi sfr bit SFR_BYTE sfr _BV bit Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 6 avr libc Data Structure Documentation 79 Deprecated include lt avr io h gt For backwards compatibility only This macro will eventually be removed Set bit bit in IO register sfr 6 avr libc Data Structure Documentation 6 1 div_t Struct Reference 6 1 1 Detailed Description Result type for function div The documentation for this struct was generated from the following file e stdlib h 6 2 Idiv_t Struct Reference 6 2 1 Detailed Description Result type for function Idiv The documentation for this struct was generated from the following file e stdlib h 7 avr libc Page Documentation 7 1 Acknowledgments This document tries to tie together the labors of a large group of people Without these individuals efforts we wouldn t have a terrific free set of tools to develop AVR projects We all
51. pgm read_byte_near address_ short Read a byte from the program space with a 16 bit near address Note The address is a byte address The address is in the program space 5 5 2 3 define pgm _read_byte_far address_long _ELPM uint32_t address_ long Read a byte from the program space with a 32 bit far address Note The address is a byte address The address is in the program space 5 5 2 4 define pgm read _byte_near address_short _LPM uint16_t address_ short Read a byte from the program space with a 16 bit near address Note The address is a byte address The address is in the program space 5 5 2 5 define pgm read _word address_short pgm_read_word_near address_ short Read a word from the program space with a 16 bit near address Note The address is a byte address The address is in the program space Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 5 Program Space String Utilities 16 5 5 2 6 define pgm read word far address long _ELPM _ word uint32_ t address_long Read a word from the program space with a 32 bit far address Note The address is a byte address The address is in the program space 5 5 2 7 define pgm_read_word_near address short _LPM_word uint16_ t address_short Read a word from the program space with a 16 bit near address Note The address is a byte address The address is in the program space 5 5 2 8 define PGM_VOID_
52. reserved for future extensions 5 14 3 4 int feof FILE x __stream Test the end of file flag of st ream This flag can only be cleared by acall to clearerr Note Since there is currently no notion for end of file on a device this function will always return a false value Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 42 5 14 3 5 int ferror FILE _ stream Test the error flag of st ream This flag can only be cleared by a call to clearerr 5 14 3 6 int fgetc FILE _ stream The function fgetc reads a character from st ream It returns the character or EOF in case end of file was encountered or an error occurred The routines feof or ferror must be used to distinguish between both situations 5 14 3 7 charx fgets char x __sfr int __size FILE _ stream Read at most size 1 bytes from st ream until a newline character was encoun tered and store the characters in the buffer pointed to by str Unless an error was encountered while reading the string will then be terminated with a NUL character If an error was encountered the function returns NULL and sets the error flag of stream which can be tested using ferror Otherwise a pointer to the string will be returned 5 14 3 8 int fprintf FILE _ stream const char _ fmt The function fprintf performs formatted output to stream See vfprintf for details 5 14 3 9 int fprintf_P FILE
53. second 5 15 4 18 int rand void The rand function computes a sequence of pseudo random integers in the range of 0 to RAND_MAX as defined by the header file lt stdlib h gt The srand function sets its argument seed as the seed for a new sequence of pseudo random numbers to be returned by rand These sequences are repeatable by calling srand with the same seed value If no seed value is provided the functions are automatically seeded with a value of 1 In compliance with the C standard these functions operate on int arguments Since the underlying algorithm already uses 32 bit calculations this causes a loss of preci sion See random for an alternate set of functions that retains full 32 bit precision 5 15 4 19 int rand_r unsigned long ctx Variant of rand that stores the context in the user supplied variable located at ct x instead of a static library variable so the function becomes re entrant 5 15 4 20 long random void The random function computes a sequence of pseudo random integers in the range of 0 to RANDOM_MAX as defined by the header file lt stdlib h gt The srandom function sets its argument seed as the seed for a new sequence of pseudo random numbers to be returned by rand These sequences are repeatable by calling srandom with the same seed value If no seed value is provided the functions are automatically seeded with a value of 1 5 15 4 21 long random_r unsigned long ctx
54. set 5 18 2 3 define bit_is_set sfr bit sfr amp _BV bit include lt avr io h gt Test whether bit bit in IO register sfr is set This will return a 0 if the bit is clear and non zero if the bit is set 5 18 2 4 define BV bit BV bit Deprecated For backwards compatibility only This macro will eventually be removed Use BV in new programs 5 18 2 5 define cbi sfr bit SFR_BYTE sfr amp _BV bit Deprecated include lt avr io h gt For backwards compatibility only This macro will eventually be removed Clear bit bit in IO register sfr Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 18 Special function registers 77 5 18 2 6 define inb sfr SFR _BYTE sfr Deprecated include lt avr io h gt For backwards compatibility only This macro will eventually be removed Use direct access in new programs 5 18 2 7 define inp sfr inb sfr Deprecated For backwards compatibility only This macro will eventually be removed Use direct access in new programs 5 18 2 8 define inw sfr SFR WORD sfr Deprecated include lt avr io h gt For backwards compatibility only This macro will eventually be removed Read a 16 bit word from IO register pair sfr Use direct access in new programs 5 18 2 9 define loop_until_bit_is_clear sfr bit do while bit_is_set sfr bit include lt avr io h gt Wait until bit bit in IO register s fr is clear 5 18 2 1
55. so on The next byte of the first operand will be B0 the next byte SCO and so on This also implies that it is often neccessary to cast the type of an input operand to the desired size A final problem may arise while using pointer register pairs If you define an input operand e ptr and the compiler selects register Z r30 r31 then A0 refers to r30 and BO refers to r31 But both versions will fail during the assembly stage of the compiler if you explicitely need Z like in ld r24 Z If you write ld r24 a0 with a lower case a following the percent sign then the compiler will create the proper assembler line 7 4 4 Clobbers As stated previously the last part of the asm statement the list of clobbers may be omitted including the colon seperator However if you are using registers which had not been passed as operands you need to inform the compiler about this The following example will do an atomic increment It increments an 8 bit value pointed to by a pointer variable in one go without being interrupted by an interrupt routine or another thread in a multithreaded environment Note that we must use a pointer because the incremented value needs to be stored before interrupts are enabled Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 110 asm volatile olim n t ld r24 a0 n t minesr24 miki st a0 r24 mat sei n t e ptr r24
56. stored in a system specific location e g under usr local avr lib ldscripts on Unix systems and consist of the AVR architecture name avr2 through avr5 with the suffix x appended They describe how the various memory sections will be linked together 7 10 3 2 Passing linker options from the C compiler By default all unknown non option arguments on the avr gcc command line i e all filename arguments that don t have a suffix that is handled by avr gcc are passed straight to the linker Thus all files ending in o object files and a object libraries are provided to the linker System libraries are usually not passed by their explicit filename but rather using the 1 option which uses an abbreviated form of the archive filename see above avr libe ships two system libraries libc a and libm a While the standard library libc a will always be searched for unresolved references when the linker is started using the C compiler frontend i e there s always at least one implied 1c option Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 142 the mathematics library 1ibm a needs to be explicitly requested using 1m See also the entry in the FAQ explaining this Conventionally Makefiles use the make macro LDLIBS to keep track of 1 and possibly L options that should only be appended to the C compiler command line when linking the final binary In contrast the macro LD
57. stream This field width is limited to at most 127 characters which is also the default value except for the c conversion that defaults to 1 The following conversion flags are supported e Matches a literal character This is not a conversion e d Matches an optionally signed decimal integer the next pointer must be a pointer to int e i Matches an optionally signed integer the next pointer must be a pointer to int The integer is read in base 16 if it begins with Ox or 0X in base 8 if it begins with 0 and in base 10 otherwise Only characters that correspond to the base are used e o Matches an octal integer the next pointer must be a pointer to unsigned int e u Matches an optionally signed decimal integer the next pointer must be a pointer to unsigned int e x Matches an optionally signed hexadecimal integer the next pointer must be a pointer to unsigned int e f Matches an optionally signed floating point number the next pointer must be a pointer to float ee g E G Equivalent to f e s Matches a sequence of non white space characters the next pointer must be a pointer to char and the array must be large enough to accept all the sequence and the terminating NUL character The input string stops at white space or at the maximum field width whichever occurs first e c Matches a sequence of width count characters default 1 the next pointer must be a pointer to char and there must be enough room for all the charact
58. terminat ing 0 character Returns The strlen function returns the number of characters in src 5 16 2 15 char x strlwr char string Convert a string to lower case The strlwr function will convert a string to lower case Only the upper case alphabetic characters A Z are converted Non alphabetic characters will not be changed Returns The strlwr function returns a pointer to the converted string Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 66 5 16 2 16 int strncasecmp const char s1 const char x s2 size_t len Compare two strings ignoring case The strncasecmp function is similar to strcasecmp except it only compares the first n characters of s1 Returns The strncasecmp function returns an integer less than equal to or greater than zero if sl or the first n bytes thereof is found respectively to be less than to match or be greater than s2 5 16 2 17 char x strncat char x dest const char x src size_t len Concatenate two strings The strncat function is similar to strcat except that only the first n characters of src are appended to dest Returns The strncat function returns a pointer to the resulting string dest 5 16 2 18 int strncmp const char s1 const char x s2 size_t len Compare two strings The strncmp function is similar to stremp except it only compares the first at most n characters of sl and s2 Ret
59. that can be passed in flags to dtostre 5 15 2 2 define DTOSTR PLUS SIGN 0x02 Bit value that can be passed in flags to dtostre 5 15 2 3 define DTOSTR_UPPERCASE 0x04 Bit value that can be passed in flags to dtostre 5 15 2 4 define RAND MAX 0x7FFF Highest number that can be generated by rand 5 15 2 5 define RANDOM MAX 0x7FFFFFFF Highest number that can be generated by random Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 53 5 15 3 Typedef Documentation 5 15 3 1 typedef int _compar_fn_t const void x const void Comparision function type for qsort just for convenience 5 15 4 Function Documentation 5 15 4 1 _inline__ void abort void The abort function causes abnormal program termination to occur In the limited AVR environment execution is effectively halted by entering an infinite loop 5 15 4 2 int abs int _1 The abs function computes the absolute value of the integer i Note The abs and labs functions are builtins of gcc 5 15 4 3 int atoi const char x string Convert a string to an integer The atoi function converts the initial portion of the string pointed to by nptr to integer representation It is equivalent to int strtol nptr char NULL 10 except that atoi does not detect errors 5 15 4 4 long int atol const char string Convert a string to a long integer The atol function converts th
60. the interrupts are doing the rest for Note 6 T return 0 7 11 3 Compiling and Linking This first thing that needs to be done is compile the source When compiling the compiler needs to know the processor type so the mmcu option is specified The s option will tell the compiler to optimize the code for efficient space usage at the possible expense of code execution speed The g is used to embed debug info The debug info is useful for disassemblies and doesn t end up in the hex files so I usually specify it Finally the c tells the compiler to compile and stop don t link This demo is small enough that we could compile and link in one step However real world projects will have several modules and will typically need to break up the building of the project into several compiles and one link avr gcc g Os mmcu at90s2333 c demo c The compilation will create a demo o file Next we link it into a binary called demo elf avr gcc g mmcu at90s2333 o demo elf demo o It is important to specify the MCU type when linking The compiler uses the mmcu option to choose start up files and run time libraries that get linked together If this option isn t specified the compiler defaults to the 8515 processor environment which is most certainly what you didn t want 7 11 4 Examining the Object File Now we have a binary file Can we do anything useful with it besides put it into the proc
61. trollers extra care should be taken to avoid unwanted side effects of the C calling conventions like implied copy constructors that could be called upon function invo cation etc These things could easily add up into a considerable amount of time and program memory wasted Thus casual inspection of the generated assembler code using the S compiler option seems to be warranted Back to FAQ Index Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 89 7 3 8 Shouldn t I initialize all my variables Global and static variables are guaranteed to be initialized to 0 by the C standard avr gcc does this by placing the appropriate code into section init4 see The initN Sections With respect to the standard this sentence is somewhat simplified because the standard allows for machines where the actual bit pattern used differs from all bits being 0 but for the AVR target in general all integer type variables are set to 0 all pointers to a NULL pointer and all floating point variables to 0 0 As long as these variables are not initialized i e they don t have an equal sign and an initialization expression to the right within the definition of the variable they go into the bss section of the file This section simply records the size of the variable but otherwise doesn t consume space neither within the object file nor within flash memory Of course being a variable it wil
62. 0 define loop_until_bit_is_set sfr bit do while bit_is_clear sfr bit include lt avr io h gt Wait until bit bit in IO register s fr is set Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 18 Special function registers 78 5 18 2 11 define outb sfr val SFR _BYTE sfr val Deprecated end Desc For backwards compatibility only This macro will eventually be removed bf Use direct access in new programs begin Desc item Note par The order of the arguments was switched in older versions of avr libc versions lt 20020203 hypertarget group__avr__sfr_all index avr_sfr avr _ sfr outp outp index outp outp avr_sfr avr _ sfr paragraph outp setlength rightskip Opt plus 5cm define outp val sfr outb sfr val hf label group__avr__sfr_all begin Desc item hyperlink deprecated__deprecated000011 Deprecated par For backwards compatibility only This macro will eventually be removed end Desc bf Use direct access in new programs hypertarget group__avr__sfr_al0 index avr_sfr avr _ sfr outw outw index outw outw avr_sfr avr _ sfr paragraph outw setlength rightskip Opt plus 5cm define outw sfr val _ SFR _ WORD s label group__avr__sfr_al0 begin Desc item hyperlink deprecated__deprecated000010 Deprecated par footnotesize begin verbatim include lt avr io h gt For backwards compatibility
63. 00 _ eeprom_end The last address in the text segment is location 0x 2 denoted by etext so the instructions use up 242 bytes of FLASH The data segment where initialized static variables are stored starts at location 0x60 which is the first address after the register bank on a 2313 processor The next available address in the data segment is also location 0x 60 so the appli cation has no initialized data The oss segment where uninitialized data is stored starts at location 0x 60 The next available address in the oss segment is location 0x63 so the application uses 3 bytes of uninitialized data The eeprom segment where EEPROM variables are stored starts at location 0x0 The next available address in the eeprom segment is also location 0x0 so there aren t any EEPROM variables Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 152 7 11 6 Intel Hex Files We have a binary of the application but how do we get it into the processor Most UT not all programmers will not accept a GNU executable as an input file so we need to do a little more processing The next step is to extract portions of the binary and save the information into hex files The GNU utility that does this is called avr objcopy The ROM contents can be pulled from our projects binary and put into the file demo hex using the following command avr objcopy j text j data O ihex demo el
64. 0100 Ox10FF 0x1100 0x2000 Ox3FFF OxFFFF on board RAM et __malloc_heap_end __heap_end et brkval _ bss_end __malloc_heap_start __heap_start _ data_end __bss_start data start Figure 3 Internal RAM variables and stack external RAM heap If _malloc_heap_endis 0 the allocator attempts to detect the bottom of stack in or der to prevent a stack heap collision when extending the actual size of the heap to gain more space for dynamic memory It will not try to go beyond the current stack limit decreased by _malloc_margin bytes Thus all possible stack frames of interrupt routines that could interrupt the current function plus all further nested function calls must not require more stack space or they will risk colliding with the data segment The default value of _malloc_margin is set to 32 7 5 4 Implementation details Dynamic memory allocation requests will be returned with a two byte header prepended that records the size of the allocation This is later used by free The returned address points just beyond that header Thus if the application accidentally writes before the returned memory region the internal consistency of the memory al locator is compromised The implementation maintains a simple freelist that accounts for memory blocks that have been returned in previous calls to free Note that all of this memory is considered to be successfully added to the heap already so no further checks ag
65. 1 Note Although the CCITT polynomial is the same as that used by the Xmodem protocol they are quite different The difference is in how the bits are shifted through the alorgithm Xmodem shifts the MSB of the CRC and the input first while CCITT shifts the LSB of the CRC and the input first The following is the equivalent functionality written in C uint16_t crc_ccitt_update uintl6_t crc uint8_t data data 108 crc data data lt lt 4 return uint1l6_t data lt lt 8 hi8 teroj uint8_t data gt gt 4 uint16_t data lt lt 3 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 3 EEPROM handling 10 5 2 2 3 uintl6t _crcxmodem update uintl6t crc uint8t static Optimized CRC XMODEM calculation Polynomial x16 x12 x 5 1 0x1021 Initial value 0x0 This is the CRC used by the Xmodem CRC protocol The following is the equivalent functionality written in C uint16_t crc_xmodem_update uintl6_t crc uint8_t data int 1 cre cre uintil6_t data lt lt 8 for i 0 i lt 8 i if cre amp 0x8000 ere cre lt lt 1 0x1021 else cre lt lt 1 return crc 5 3 EEPROM handling 5 3 1 Detailed Description include lt avr eeprom h gt _data This header file declares the interface to some simple library routines suitable for han dling the data EEPROM contained in the AVR microcontrollers The implementation uses a sim
66. 131 7 8 6 UISP Uisp also uses the configure system so to build and install gunzip c uisp lt version gt tar gz tar xf cd uisp lt version gt mkdir obj avr cd obj avr configure prefix PREFIX make make install TMT OY TA Kr Oe 7 8 7 Avrdude Note It has been ported to windows via cygwin and linux Other unix systems should be trivial to port to avrdude is part of the FreeBSD ports system To install it simply do the following cd usr ports devel avrdude make install Note Installation into the default location usually requires root permissions However running the program only requires access permissions to the appropriate ppi 4 device Building and installing on other systems should use the configure system as such gunzip c avrdude lt version gt tar gz tar xf cd avrdude lt version gt mkdir obj avr cd obj avr configure prefix PREFIX make make install ZA Ura Te Ur TE 7 8 8 GDB for the AVR target Gdb also uses the configure system so to build and install bunzip2 c gdb lt version gt tar bz2 tar xf cd gdb lt version gt mkdir obj avr cd obj avr configure prefix PREFIX target avr make make install Gt ETT A A L e E Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 8 Installing the GNU Tool Chain 132 Note If you are planning on using avr gdb you will probably want to install either simulavr or avaric
67. 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 108 Input operands are you guessed it read only But what if you need the same operand for input and output As stated above read write operands are not supported in inline assembler code But there is another solution For input operators it is possible to use a single digit in the constraint string Using digit n tells the compiler to use the same register as for the n th operand starting with zero Here is an example asm volatile swap 0 r value 0 value This statement will swap the nibbles of an 8 bit variable named value Constraint 0 tells the compiler to use the same input register as for the first operand Note however that this doesn t automatically imply the reverse case The compiler may choose the same registers for input and output even if not told to do so This is not a problem in most cases but may be fatal if the output operator is modified by the assembler code before the input operator is used In the situation where your code depends on different registers used for input and output operands you must add the amp constraint modifier to your output operand The following example demonstrates this problem asm volatile in 0 1 NANE Tout Sl 327 igre amp r input I port r output In this example an input value is read from a port and then an output value is written to the same port If the compiler would have choosen
68. 32_t avr_inttypes 28 int64_t avr_inttypes 28 int8_t avr_inttypes 28 Integer Types 27 INTERRUPT avr_interrupts 72 Interrupts and Signals 68 intptr_t avr_inttypes 28 inverse avr_math 32 inw avr_sfr 76 isalnum ctype 25 isalpha ctype 25 isascii ctype 25 isblank ctype 25 iscntrl ctype 25 isdigit ctype 25 isgraph ctype 25 isinf avr_math 32 islower ctype 25 isnan avr_math 32 isprint ctype 25 ispunct ctype 25 isspace ctype 25 isupper ctype 26 isxdigit ctype 26 itoa avr_stdlib 54 labs avr_stdlib 55 Idexp avr_math 32 Idiv avr_stdlib 55 Idiv t 78 log avr math 32 log10 avr_math 32 longjmp setimp 35 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 175 loop_until_bit_is_clear avr_sfr 76 loop_until_bit_is_set avr_sfr 77 Itoa avr_stdlib 55 M_PI avr_math 30 M_SQRT2 avr_math 30 malloc avr_stdlib 56 Mathematics 29 memccpy avr_string 61 memchr avr_string 61 memcmp avr_string 61 memcpy avr_string 62 memcpy_P avr_pgmspace 16 memmove avr_string 62 memset avr_string 62 modf avr_math 33 outb avr_sfr 77 PGM_P avr_pgmspace 14 pgm_read_byte avr_pgmspace 14 pgm_read_byte_far avr_pgmspace 14 pgm_read_byte_near avr_pgmspace 15 pgm_read_word avr_pgmspace 15 pgm_read_word_far avr_pgmspace 15 pgm_read_word_near avr_pgmspace 15 PGM_VOID_P avr_pgmspace 15 pow
69. 72 us 20 1 ms mcall prologues The difference between 955 us and 972 us was just a single timer tick so take this with a grain of salt So generally it seems Os mcall prologues is the most universal best opti mization level Only applications that need to get the last few percent of speed benefit from using 03 Back to FAQ Index 7 3 18 How do I relocate code to a fixed address First the code should be put into a new named section This is done with a section attribute _attribute__ section bootloader In this example boot loader is the name of the new section This attribute needs to be placed after the prototype of any function to force the function into the new section void boot void __attribute__ section bootloader To relocate the section to a fixed address the linker flag section start is used This option can be passed to the linker using the W1 compiler option W1 section start boot loader 0x1E000 The name after section start is the name of the section to be relocated The number after the section name is the beginning address of the named section Back to FAQ Index Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 100 7 3 19 My UART is generating nonsense My ATmega128 keeps crashing Port F is completely broken Well certain odd problems arise out of the situation that the AVR devices as shipped
70. 90s8535 ATmega Type Devices atmega8 atmega103 atmega128 atmega 16 atmegal61 atmega162 atmega163 atmega169 atmega32 atmega323 atmega64 untested atmega8515 untested atmega8535 untested ATtiny Type Devices attiny11 1 attiny12 1 attiny15 1 attiny22 attiny26 attiny28 1 Misc Devices e at94K 2 at76c711 3 at43usb320 at43usb355 at86rf401 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 2 avr libc Module Index Note 1 Assembly only There is no support for these devices to be programmed in C since they do not have a ram based stack Note 2 The at94K devices are a combination of FPGA and AVR microcontroller TRoth 2002 11 12 Not sure of the level of support for these More information would be welcomed Note 3 The at76c711 is a USB to fast serial interface bridge chip using an AVR core 2 avr libc Module Index 2 1 avr libc Modules Here is a list of all modules Bootloader Support Utilities CRC Computations EEPROM handling AVR device specific IO definitions Program Space String Utilities Power Management and Sleep Modes Watchdog timer handling Character Operations System Errors errno Integer Types Mathematics Setjmp and Longjmp Standard IO facilities General utilities 10 12 13 21 22 24 27 28 30 34 36 50 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 3 avr libc Data Structure
71. EPROM address addr 5 3 3 6 void eeprom_write_word uint16_t x addr uint16_t val Write a word val to EEPROM address addr 5 4 AVR device specific IO definitions include lt avr io h gt Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 5 Program Space String Utilities 13 This header file includes the apropriate IO definitions for the device that has been spec ified by the mmcu compiler command line switch This is done by diverting to the appropriate file lt avr ioXXXX h gt which should never be included directly Some register names common to all AVR devices are defined directly within lt avr io h gt but most of the details come from the respective include file Note that this file always includes include lt avr sfr_defs h gt See Special function registers for the details Included are definitions of the IO register set and their respective bit values as specified in the Atmel documentation Note that Atmel is not very consistent in its naming conventions so even identical functions sometimes get different names on different devices Also included are the specific names useable for interrupt function definitions as docu mented here Finally the following macros are defined e RAMEND A constant describing the last on chip RAM location e XRAMEND A constant describing the last possible location in RAM This is equal to RA MEND for devices that do not allow for external RAM s E2END
72. F LAGS is used to store other command line options to the C compiler that should be passed as options during the linking stage The difference is that options are placed early on the command line while libraries are put at the end since they are to be used to resolve global symbols that are still unresolved at this point Specific linker flags can be passed from the C compiler command line using the W1 compiler option see above This option requires that there be no spaces in the appended linker option while some of the linker options above like Map or defsym would require a space In these situations the space can be replaced by an equal sign as well For example the following command line can be used to compile foo c into an executable and also produce a link map that contains a cross reference list in the file foo map avr gcc 0 o foo out Wl Map foo map W1l cref foo c Alternatively a comma as a placeholder will be replaced by a space before passing the option to the linker So for a device with external SRAM the following command line would cause the linker to place the data segment at address 0x2000 in the SRAM avr gcc mmcu atmegal28 o foo out W1 Tdata 0x802000 See the explanation of the data section for why 0x800000 needs to be added to the ac tual value Note that unless a minit stack option has been given when compiling the C source file that contains the function main the stack will still remain in i
73. It currently always returns 0 for success 5 14 3 3 FILE fdevopen int put char int x get void int opts _attribute_ unused This function is a replacement for fopen It opens a stream for a device where the actual device implementation needs to be provided by the application If successful a pointer to the structure for the opened stream is returned Reasons for a possible failure currently include that neither the put nor the get argument have been provided thus attempting to open a stream with no IO intent at all or that insufficient dynamic memory is available to establish a new stream If the put function pointer is provided the stream is opened with write intent The function passed as put shall take one character to write to the device as argument and shall return 0 if the output was successful and a nonzero value if the character could not be sent to the device If the get function pointer is provided the stream is opened with read intent The function passed as get shall take no arguments and return one character from the device passed as an int type If an error occurs when trying to read from the device it shall return 1 If both functions are provided the stream is opened with read and write intent The first stream opened with read intent is assigned to st din and the first one opened with write intent is assigned to both stdout and stderr The third parameter opts is currently unused but
74. M regardless of whether or not the variables from the data and bss sections are also going to be located there The stack should always be kept in internal RAM Some devices even require this and in general internal RAM can be accessed faster since no extra wait states are required When using dynamic memory allocation and stack and heap are separated in distinct memory areas this is the safest way to avoid a stack heap collision 7 5 3 Tunables for malloc There are a number of variables that can be tuned to adapt the behavior of malloc to the expected requirements and constraints of the application Any changes to these Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 5 Using malloc 116 tunables should be made before the very first call to malloc Note that some library functions might also use dynamic memory notably those from the Standard IO facili ties so make sure the changes will be done early enough in the startup sequence The variables _malloc_heap_start and _malloc_heap_end can be used to re strict the malloc function to a certain memory region These variables are statically initialized to point to _heap_start and _heap_end respectively where _heap_ start is filled in by the linker to point just beyond oss and _heap_end is set to 0 which makes malloc assume the heap is below the stack If the heap is going to be moved to external RAM _malloc_heap_end must be adjusted accordingl
75. MEM foo bar int main void char buf 32 strcpy_P buf array 1 return 0 Looking at the disassembly of the resulting object file we see that array is in flash as such 0000008c lt foo gt 8c 46 6f ori r20 OxF6 246 8e 6f 00 word Ox006f 27777 00000090 lt bar gt 90 42 61 ori r20 0x12 18 92 72 00 word Ox0072 2 00000094 lt array gt 94 8c 00 word Ox008c 2 96 90 00 word 0x0090 7222 foo is at addr Ox008c bar is at addr 0x0090 array is at addr 0x0094 Then in main we see this strcpy_P buf array 1 copy bar into buf de 60 e9 ldi r22 0x90 144 e0 70 e0 Idi r23 0x00 0 e2 ce 01 movw r24 r28 e4 01 96 adiw r24 0x01 xd e6 Oe 94 79 00 call Oxf2 The addr of bar 0x0090 is loaded into the r23 r22 pair which is the second parameter passed to strcpy_P The r25 r24 pair is the addr of buf Back to FAQ Index Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 98 7 3 16 How to use external RAM Well there is no universal answer to this question it depends on what the external RAM is going to be used for Basically the bit SRE SRAM enable in the MCUCR register needs to be set in order to enable the external memory interface Depending on the device to be used and the application details further registers affecting the external memory operation like XMCRA and XMCRB and or further bits in MCUCR
76. Nov 26 21 10 23 2003 for avr libc by Doxygen 7 8 Installing the GNU Tool Chain 130 To save your self some download time you can alternatively download only the gcc core lt version gt tar bz2 and gcc c lt version gt tar bz2 parts of the gcc Also if you don t need C support you only need the core part and should only enable the C language support Note Early versions of these tools did not support C Note The stdc libs are not included with C for AVR due to the size limitations of the devices 7 8 5 AVR Libc Warning You must install avr binutils avr gcc and make sure your path is set properly before installing avr libc Note If you have obtained the latest avr libc from cvs you will have to run the reconf script before using either of the build methods described below To build and install avr libc gunzip c avr libc lt version gt tar gz cd avr libc lt version gt doconf domake cd build make install Note The doconf script will automatically use the PREF IX environment variable if you have set and exported it Alternatively you could do this shown for consistency with binutils and gcc gunzip c avr libc lt version gt tar gz tar xf cd avr libc lt version gt mkdir obj avr cd obj avr configure prefix PREFIX make make install ZB B ZB B ZB LB wn Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 8 Installing the GNU Tool Chain
77. P const prog_void x Used to declare a generic pointer to an object in program space 5 5 2 9 define PRG_RDB addr pgm_read_byte addr Deprecated Use pgm_read_byte in new programs 5 5 2 10 define PSTR s static char __c PROGMEM s _ c Used to declare a static pointer to a string in program space 5 5 3 Function Documentation 5 5 3 1 void x memcpy_P void dest PGM_VOID P src size_t n The memcpy_P function is similar to memcpy except the src string resides in pro gram space Returns The memcpy_P function returns a pointer to dest Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 5 Program Space String Utilities 17 5 5 3 2 int strcasecmp_P const char x s1 PGM_P s2 Compare two strings ignoring case The strcasecmp_P function compares the two strings sl and s2 ignoring the case of the characters Parameters sl A pointer to a string in the devices SRAM s2 A pointer to a string in the devices Flash Returns The strcasecmp_P function returns an integer less than equal to or greater than zero if sl is found respectively to be less than to match or be greater than s2 5 5 3 3 char x strcat_P char x dest PGM P src The strcat_P function is similar to strcat except that the src string must be located in program space flash Returns The strcat function returns a pointer to the resulting string dest 5 5 3 4 int stremp_P const char s1 PGM
78. R device initialized and ready to accept instructions avrdude Device signature 0xle9101 avrdude gt The command displays a list of valid commands avrdude gt gt gt gt Valid commands dump dump memory dump lt memtype gt lt addr gt lt N Bytes gt read alias for dump write write memory write lt memtype gt lt addr gt lt bil gt lt b2 gt lt bN gt erase perform a chip erase sig display device signature bytes part display the current part information send send a raw command send lt bl gt lt b2 gt lt b3 gt lt b4 gt help help 2 help quit quit Use the part command to display valid memory types for use with the dump and write commands avrdude gt 7 10 Using the GNU tools This is a short summary of the AVR specific aspects of using the GNU tools Normally the generic documentation of these tools is fairly large and maintained in texinfo Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 10 Using the GNU tools 135 files Command line options are explained in detail in the manual page 7 10 1 Options for the C compiler avr gcc 7 10 1 1_Machine specific options for the AVR The following machine specific options are recognized by the C compiler frontend e mmcu architecture Compile code for architecture Currently known architectures are avrl Simple CPU core only assembler support avr2 Cla
79. RC Computations 5 2 1 Detailed Description include lt avr crc16 h gt This header file provides a optimized inline functions for calculating 16 bit cyclic re dundancy checks CRC using common polynomials References See the Dallas Semiconductor app note 27 for 8051 assembler example and general CRC optimization suggestions The table on the last page of the app note is the key to understanding these implementations Jack Crenshaw s Impementing CRCs article in the January 1992 isue of Embed ded Systems Programming This may be difficult to find but it explains CRC s in very clear and concise terms Well worth the effort to obtain a copy Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 2 CRC Computations Functions e uintl6_t __crc16_update uint16_t _crc uint8_t __data e uintl6_t _crc_xmodem_update uint16_t __crc uint8_t __data e uintl6_t__crc_ccitt_update uint16_t _crc uint8_t __data 5 2 2 Function Documentation 5 2 2 1 uint16_t _crcl16_update uint16_t _crc uint8_t _data static Optimized CRC 16 calcutation Polynomial x16 x15 x 2 1 0xa001 Initial value Oxffff This CRC is normally used in disk drive controllers 5 2 2 2 uint16_t _crc_ccitt_update uint16_t _crc uint8_t _data static Optimized CRC CCITT calculation Polynomial x16 x12 x5 1 0x8408 Initial value Oxffff This is the CRC used by PPP and IrDA See RFC1171 PPP protocol and IrDA IrLAP 1
80. VR instruction set The author s as sumption is that this part of the compiler has never been really finished in this version but that assumption may be wrong The selection of the proper contraint depends on the range of the constants or registers which must be acceptable to the AVR instruction they are used with The C compiler doesn t check any line of your assembler code But it is able to check the constraint against your C expression However if you specify the wrong constraints then the compiler may silently pass wrong code to the assem bler And of course the assembler will fail with some cryptic output or internal errors For example if you specify the constraint r and you are using this register with an ori instruction in your assembler code then the compiler may select any register This will fail if the compiler chooses r2 to r15 It will never choose r0 or r1 because these are uses for special purposes That s why the correct constraint in that case is d On the other hand if you use the constraint M the compiler will make sure that you don t pass anything else but an 8 bit value Later on we will see how to pass multibyte expression results to the assembler code The following table shows all AVR assembler mnemonics which require operands and the related contraints Because of the improper constraint definitions in version 3 3 they aren t strict enough There is for example no constraint which restricts
81. _P s2 The stremp_P function is similar to stremp except that s2 is pointer to a string in program space Returns The stremp_P function returns an integer less than equal to or greater than zero if sl is found respectively to be less than to match or be greater than s2 5 5 3 5 char strepy_P char dest PGM P src The strepy_P function is similar to strcpy except that src is a pointer to a string in program space Returns The strcpy_P function returns a pointer to the destination string dest Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 5 Program Space String Utilities 18 5 5 3 6 size_t stricat_P char x dst PGM P size_t siz Concatenate two strings The strlcat_P function is similar to strlcat except that the src string must be located in program space flash Appends src to string dst of size siz unlike strncat siz is the full size of dst not space left At most siz 1 characters will be copied Always NULL terminates unless siz lt strlen dst Returns The strlcat_P function returns strlen src MIN siz strlen initial dst If retval gt siz truncation occurred 5 5 3 7 size_t strlepy_P char dst PGM_P size_t siz Copy a string from progmem to RAM Copy src to string dst of size siz At most siz 1 characters will be copied Always NULL terminates unless siz 0 Returns The strlcpy_P function returns strlen src If retval gt siz
82. __ and _zero_reg_ instead of ro or r1 just in case a new compiler version changes the register usage definitions 7 4 3 Input and Output Operands Each input and output operand is described by a constraint string followed by a C expression in parantheses AVR GCC 3 3 knows the following constraint characters Note The most up to date and detailed information on contraints for the avr can be found in the gcc manual Note The x register is r27 r26 the y register is r29 r28 and the z register is 31 130 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 106 Constraint Used for Range a Simple upper registers 116 to r23 b Base pointer registers y Z pairs d Upper register rl6tor31 e Pointer register pairs X y Z G Floating point constant 0 0 I 6 bit positive integer 0 to 63 constant J 6 bit negative integer 63 to 0 constant K Integer constant 2 L Integer constant 0 l Lower registers r0 to r15 M 8 bit integer constant 0 to 255 N Integer constant 1 O Integer constant 8 16 24 P Integer constant 1 q Stack pointer register SPH SPL T Any register r0 to 131 t Temporary register r0 W Special upper register 124 r26 r28 r30 pairs x Pointer register pair X X 127 126 y Pointer register pair Y y 129 r28 Z Pointer register pair Z z r31 r30 These definitions seem not to fit properly to the A
83. _wait strncat 65 avr_boot 7 strncmp 65 boot_spm_interrupt_disable strncpy 66 avr_boot 7 strnlen 66 boot_spm_interrupt_enable strrchr 66 avr_boot 7 strrev 67 Bootloader Support Utilities 4 strsep 67 BOOTLOADER SECTION strstr 67 avr_boot 7 strtok_r 67 bsearch strupr 68 avr_stdlib 53 avr_watchdog BV wdt_disable 22 avr_sfr 75 wdt_enable 22 wdt_reset 23 calloc WDTO_120MS 23 avr_stdlib 53 WDTO_15MS 23 cbi WDTO_I1S 23 avr_sfr 76 WDTO_250MS 23 ceil WDTO_2S 23 avr_math 31 WDTO_30MS 23 Character Operations 24 WDTO_500MS 23 clearerr WDTO_60MS 24 avr_stdio 40 avrdude usage 133 cli avrprog usage 133 avr_interrupts 72 cos bit_is_clear avr_math 31 avr_sfr 75 cosh bit_is_set avr_math 31 avr_sfr 75 CRC Computations 8 boot_is_spm_interrupt ctype avr_boot 6 isalnum 25 boot_lock_bits_set isalpha 25 avr_boot 6 isascii 25 boot_page_erase isblank 25 avr_boot 6 iscntrl 25 boot_page_fill isdigit 25 avr_boot 6 isgraph 25 boot_page_write islower 25 avr_boot 7 isprint 25 boot_rww_busy ispunct 25 avr_boot 7 isspace 25 boot rww_enable isupper 26 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 173 isxdigit 26 toascii 26 tolower 26 toupper 26 disassembling 146 div avr_stdlib 53 div_t 78 DTOSTR_ALWAYS_SIGN avr_stdlib 51 DTOSTR_PLUS_SIGN avr_stdlib 51 DTOSTR_UPPERCASE avr_stdlib 52 dtostre avr_stdlib 53 dtostrf avr_stdlib 54 EDOM avr_e
84. a handler for the ADC interrupt include lt avr signal h gt INTERRUPT SIG_ADC user code here Refer to the chapter explaining assembler programming for an explanation about inter rupt routines written solely in assembler language If an unexpected interrupt occurs interrupt is enabled and no handler is installed which usually indicates a bug then the default action is to reset the device by jumping to the reset vector You can override this by supplying a function named _vector_ default which should be defined with either SIGNAL or INTERRUPT as such include lt avr signal h gt SIGNAL __vector_default user code here Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 17 Interrupts and Signals 70 The interrupt is chosen by supplying one of the symbols in following table Note that every AVR device has a different interrupt vector table so some signals might not be available Check the data sheet for the device you are using FIXME Fill in the blanks Gotta read those durn data sheets Note The SIGNAL and INTERRUPT macros currently cannot spell check the argu ment passed to them Thus by misspelling one of the names below in a call to SIGNAL or INTERRUPTO a function will be created that while possibly being usable as an interrupt function is not actually wired into the interrupt vector table No warning will be given about this situation
85. addr Defines define PSTR s static char _c PROGMEM s _ c e define pgm read _byte_near address_short _LPM uint16_t address_short e define pgm _read_word_near address_short _LPM_word uint16_t address_ short define pgm_read_byte_far address_long _ELPM uint32_t address_long define pgm_read_word_far address_long _ELPM_word uint32_t address_ long define pgm_read_byte address_short pgm_read_byte _near address_short define pgm_read_word address_short pgm_read_word_near address_short define PGM_P const prog_char define PGM_VOID_P const prog_void x Functions void x memcpy_P void x PGM_VOID_P size_t int strcasecmp_P const char x PGM_P __ATTR_PURE__ char x strcat_P char x PGM_P int stremp_P const char x PGM_P _ATTR_PURE__ char strcpy_P char x PGM_P size_t strlcat_P char x PGM_P size_t size_t strlcpy_P char x PGM_P size_t Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 5 Program Space String Utilities 15 e size_t strlen P PGM_P _ATTR CONST__ e int strncasecmp_P const char x PGM_P size_t _ATTR_PURE_ e char x strncat_P char x PGM_P size_t e int strncmp_P const char x PGM_P size_t _ATTR_PURE_ e char x strncpy_P char x PGM _P size_t 5 5 2 Define Documentation 5 5 2 1 define PGM_P const prog_char x Used to declare a variable that is a pointer to a string in program space 5 5 2 2 define pgm read byte address_short
86. age For example suppose you wish to place the noinit section at SRAM address 0x2000 avr gcc Wl section start noinit 0x802000 Note Because of the Harvard architecture of the AVR devices you must manually add 0x800000 to the address you pass to the linker as the start of the section Oth erwise the linker thinks you want to put the noinit section into the text section instead of data bss and will complain Alternatively you can write your own linker script to automate this FIXME need an example or ref to dox for writing linker scripts 7 7 6 The initN Sections These sections are used to define the startup code from reset up through the start of main These all are subparts of the text section The purpose of these sections is to allow for more specific placement of code within your program Note Sometimes it is convenient to think of the initN and finiN sections as functions but in reality they are just symbolic names which tell the linker where to stick a chunk of code which is not a function Notice that the examples for asm and C can not be called as functions and should not be jumped into The initN sections are executed in order from 0 to 9 init0 Weakly bound to __init If user defines __init it will be jumped into immediately after a reset Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 7 Memory Sections 124 init1 Unused User definable ini
87. ainst stack heap collisions are done when recycling memory from the freelist The freelist itself is not maintained as a separate data structure but rather by modifying the contents of the freed memory to contain pointers chaining the pieces together That way no additional memory is reqired to maintain this list except for a variable that keeps track of the lowest memory segment available for reallocation Since both a chain pointer and the size of the chunk need to be recorded in each chunk the minimum chunk size on the freelist is four bytes Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 6 Release Numbering and Methodology 118 When allocating memory first the freelist is walked to see if it could satisfy the request If there s a chunk available on the freelist that will fit the request exactly it will be taken disconnected from the freelist and returned to the caller If no exact match could be found the closest match that would just satisfy the request will be used The chunk will normally be split up into one to be returned to the caller and another smaller one that will remain on the freelist In case this chunk was only up to two bytes larger than the request the request will simply be altered internally to also account for these additional bytes since no separate freelist entry could be split off in that case If nothing could be found on the freelist heap extension is attempted This is where _m
88. al value of nptrinendptr Thus if xnptr is not 0 but xxendpt r is 0 on return the entire string was valid The strtol function returns the result of the conversion unless the value would under flow or overflow If no conversion could be performed 0 is returned If an overflow or underflow occurs errno is set to ERANGE and the function return value is clamped to LONG_MIN or LONG_MAX respectively 5 15 4 26 unsigned long strtoul const char _nptr char xx __endptr int _base The strtoul function converts the string in npt r to an unsigned long value The con version is done according to the given base which must be between 2 and 36 inclusive or be the special value 0 The string may begin with an arbitrary amount of white space as determined by iss pace followed by a single optional or sign If base is zero or 16 the string may then include a 0x prefix and the number will be read in base 16 otherwise a zero base is taken as 10 decimal unless the next character is 0 in which case it is taken as 8 octal The remainder of the string is converted to an unsigned long value in the obvious manner stopping at the first character which is not a valid digit in the given base In bases above 10 the letter A in either upper or lower case represents 10 B represents 11 and so forth with Z representing 35 If endptr is not NULL strtoul stores the address of the first
89. alks to a 24Cxx IC EEPROM using the builtin TWI interface of an ATmega device XT include lt inttypes h gt include lt stdio h gt include lt stdlib h gt include lt avr io h gt include lt avr twi h gt Note 1 define DEBUG 1 System clock in Hz oy define SYSCLK 14745600UL Note 2 L Compatibility defines This should work on ATmega8 ATmegal6 ATmegal63 ATmega323 and ATmegal28 IOW on all devices that provide a builtin TWI interface L L L On the 128 it defaults to USART 1 ifndef UCSRB ifdef UCSRIA ATmega128 define UCSRA UCSRIA define UCSRB UCSRIB define UBRR UBRRIL define UDR UDRI else ATmega8 define UCSRA USR define UCSRB UCR endif endif ifndef UBRR define UBRR UBRRL endif Note 3 TWI address for 24Cxx EEPROM 1 0 1 0 E2 El EO R W 24C01 24C02 1 0 1 0 E2 El A8 R W 24C04 1 0 1 0 E2 A9 A8 R W 24C08 10 1 0 A10 A9 A8 R W 24C16 Joerg Wunsch Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 157 ay define TWI_SLA_24CXX Oxa0 EZ El EO 000 Maximal number of iterations to wait for a device to respond for a selection Should be large enough to allow for a pending write to complete but low enough to properly abort an infinite loop in case a slave is broken or not present at all With 100 kHz TWI clock transfe
90. alloc_margin will be considered if the heap is operating below the stack or where _malloc_heap_end will be verified otherwise If the remaining memory is insufficient to satisfy the request NULL will eventually be returned to the caller When calling free a new freelist entry will be prepared An attempt is then made to aggregate the new entry with possible adjacent entries yielding a single larger entry available for further allocations That way the potential for heap fragmentation is hopefully reduced 7 6 Release Numbering and Methodology 7 6 1 Release Version Numbering Scheme 7 6 1 1 Stable Versions A stable release will always have a minor number that is an even number This implies that you should be able to upgrade to a new version of the library with the same major and minor numbers without fear that any of the APIs have changed The only changes that should be made to a stable branch are bug fixes and under some circumstances additional functionality e g adding support for a new device If major version number has changed this implies that the required versions of gcc and binutils have changed Consult the README file in the toplevel directory of the AVR Libc source for which versions are required 7 6 1 2 Development Versions The major version number of a development series is always the same as the last stable release The minor version number of a development series is always an odd number and is 1 more than the las
91. an indirect port access is going to one of the 16 bit IO registers where the order of write access is critical like some timer registers All versions of avr gcc up to 3 3 will generate instructions that use the wrong access order in this situation since with normal memory operands where the order doesn t matter this sometimes yields shorter code Seehttp mail nongnu org archive html avr libc dev 2003 01 msg00044 html for a possible workaround avr gcc versions after 3 3 have been fixed in a way where this optimization will be disabled if the respective pointer variable is declared to be volatile so the correct behaviour for 16 bit IO ports can be forced that way Back to FAQ Index 7 3 14 What registers are used by the C compiler e Data types char is 8 bits int is 16 bits long is 32 bits long long is 64 bits float and double are 32 bits this is the only supported floating point format pointers are 16 bits function pointers are word addresses to allow addressing the whole 128K program memory space on the ATmega devices with gt 64 KB of flash ROM There is a mint 8 option see Options for the C compiler avr gcc to make int 8 bits but that is not supported by avr libc and violates C standards int must be at least 16 bits It may be removed in a future release Call used registers r18 r27 r30 r31 May be allocated by gcc for local data You may use them freely in assem bler subroutines Calling C subroutin
92. aracters including the trailing NUL character will be converted to s Returns the number of characters that would have been written to s if there were enough space 5 14 3 25 int snprintf_P char gt __s size_t _n const char x __fmt Variant of snprintf that uses a fmt string that resides in program memory 5 14 3 26 int sprintf char _s const char __fmt Variant of printf that sends the formatted characters to string s 5 14 3 27 int sprintf_P char gt __s const char __ fmt Variant of sprintf that uses a fmt string that resides in program memory 5 14 3 28 int sscanf const char x __buf const char x _ fmt The function sscanf performs formatted input reading the input data from the buffer pointed to by buf See vfscanf for details 5 14 3 29 int sscanf_P const char _buf const char __fint Variant of sscanf using a fmt string in program memory Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 45 5 14 3 30 int ungetc int _c FILE _ stream The ungetc function pushes the character c converted to an unsigned char back onto the input stream pointed to by st ream The pushed back character will be returned by a subsequent read on the stream Currently only a single character can be pushed back onto the stream The ungetc function returns the character pushed back after the conversion or EOF if the
93. at don t fit are passed on the stack Return values 8 bit in r24 not r25 16 bit in r25 124 up to 32 bits in r22 r25 up to 64 bits in r18 r25 8 bit return values are zero sign extended to 16 bits by the caller unsigned char is more efficient than signed char just clr r25 Arguments to functions with variable argument lists printf etc are all passed on stack and char is extended to int Warning There was no such alignment before 2000 07 01 including the old patches for gcc 2 95 2 Check your old assembler subroutines and adjust them accordingly Back to FAQ Index 7 3 15 How do I put an array of strings completely in ROM There are times when you may need an array of strings which will never be modified In this case you don t want to waste ram storing the constant strings The most obvious and incorrect thing to do is this include lt avr pgmspace h gt PGM_P array 2 PROGMEM Foo Bar int main void char buf 32 strcpy_P buf array 1 return 0 The result is not want you want though What you end up with is the array stored in ROM while the individual strings end up in RAM in the data section To work around this you need to do something like this Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 97 include lt avr pgmspace h gt const char foo PROGMEM Foo const char bar PROGMEM Bar PGM_P array 2 PROG
94. ault goto error quit TWCR _BV TWINT _BV TWSTO _BV TWEN send stop condition return rv error rv 1 goto quit Wrapper around ee24xx_write_page that repeats calling this function until either an error has been returned or all bytes have been written int ee24xx_write_bytes uint1l6_t eeaddr int len uint8_t buf int rv total total 0 do if DEBUG printf Calling ee24xx_write_page d d p eeaddr len buf endif rv ee24xx_write_page eeaddr len buf if DEBUG printf gt d n rv endif if rv 1 return 1 eeaddr rv len rv buf rv total rv while len gt 0 return total void error void Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 164 printf error TWI status x n twst exit 0 void main void uintib t ar int rv uint8_t b 16 uint8_t x ioinit fdevopen uart_putchar NULL 0 for a 0 a lt 256 printf S 04x a rv ee24xx_read_bytes a 16 b if rvo lt 0 error if rv lt 16 printf warning short read d n rv a rv for x 0 x lt rv x printf 02x b x putchar n define EE_WRITE addr str ee24xx_write_bytes addr sizeof str 1 rv EE_WRITE 55 The quick brown fox jumps over the lazy dog if rv lt 0 error printf
95. avr libc Reference Manual 1 0 2 Generated by Doxygen 1 2 18 Wed Nov 26 21 10 21 2003 CONTENTS Contents 1 AVRLibc 1 1 0 1 Supported Devices lt lt e e R e ee a tome 2 2 avr libc Module Index 3 21 avrlibe Modules oo e e e R R a hee eee ee ae 3 3 avr libe Data Structure Index 31 avr libe Data Structures s s lt oc seame g biag 4 4 avr libc Page Index 4 1 ayrlibe Related Pages co 9 a ce ee Ee RRS 4 5 avr libc Module Documentation 5 5 1 Bootloater Support Utilities gt lt so s esser wee RR 5 SLI Detailed Description ee secese 45 eee creses 5 3 1 2 Define Documentation lt s s r e Pe a Ae 7 32 RC Computations 34 go a daa ke eara aaea ae 8 321 Detailed Description lt x 22452285 ea aaee TE 8 5 2 2 Function Documentation xe e a ee rsak 9 53 BEPROM handling 2 ee ee edeti u ee ew R 10 ok Detaled Deseripnan lt s cs sa a we hole a RTA BARS 10 33 2 Defne Dooumentaion s ge esp pedak ee aras 11 5 3 3 Function Documentation oaoa 12 5 4 AVR device specific IO definitions 0 0 12 5 5 Program Space Strme UGliNes co os 6 a g ew eR R 13 5 541 Detailed Description gt gt e s ereere deute 13 33 2 Define DOCtIMeNntAIOM lt a sose mapa api a E 15 5 5 5 F n tion Documentation lt 4 24 64005 ba o 16 5 6 Additional notes from lt avr sfrdefsh gt 19 5 7 Power Management and Sleep Modes 21 T A Detailed Description gt c
96. be stored under s The caller is responsible for providing sufficient storage in s Conversion is done in the format d ddd The minimum field width of the output string including the and the possible sign for negative values is given in width and prec determines the number of digits after the decimal sign 5 15 4 10 void exit int __status The exit function terminates the application Since there is no environment to re turn to status is ignored and code execution will eventually reach an infinite loop thereby effectively halting all code processing In a C context global destructors will be called before halting execution 5 15 4 11 void free void __pfr The free function causes the allocated memory referenced by pt r to be made avail able for future allocations If pt r is NULL no action occurs 5 15 4 12 charx itoa int _val char x _s int __radix Convert an integer to a string The function itoa converts the integer value from val into an ASCII representation that will be stored under s The caller is responsible for providing sufficient storage in Ss Note The minimal size of the buffer s depends on the choice of radix For example if the radix is 2 binary you need to supply a buffer with a minimal length of 8 sizeof int 1 characters i e one character for each bit plus one for the string terminator Using a larger radix will require a smaller minimal buffer size Warning If the buff
97. binaries will get installed in usr local bin the info pages get installed in usr local info etc Since these tools are chang ing frequently It is preferrable to put them in a location that is easily removed When configure is run it generates a lot of messages while it determines what is available on your operating system When it finishes it will have created several Makefiles that are custom tailored to your platform At this point you can build the project make Note BSD users should note that the project s Makefile uses GNU make syntax This means FreeBSD users may need to build the tools by using gmake If the tools compiled cleanly you re ready to install them If you specified a destination that isn t owned by your account you ll need root access to install them To install make install You should now have the programs from binutils installed into SPREFIX bin Don t forget to set your PATH environment variable before going to build avr gcc 7 8 4 GCC for the AVR target Warning You must install avr binutils and make sure your path is set properly before in stalling avr gcc The steps to build avr gcc are essentially same as for binutils bunzip2 c gcc lt version gt tar bz2 tar xf cd gcc lt version gt mkdir obj avr cd obj avr configure prefix PREFIX target avr enable languages c c disable nls make make install LB ZD ZD ZB LT mn LT Generated on Wed
98. by Atmel often come with a default fuse bit configuration that doesn t match the user s expectations Here is a list of things to care for e All devices that have an internal RC oscillator ship with the fuse enabled that causes the device to run off this oscillator instead of an external crystal This often remains unnoticed until the first attempt is made to use something critical in timing like UART communication e The ATmegal28 ships with the fuse enabled that turns this device into AT megal03 compatibility mode This means that some ports are not fully usable and in particular that the internal SRAM is located at lower addresses Since by default the stack is located at the top of internal SRAM a program compiled for an ATmega128 running on such a device will immediately crash upon the first function call or rather upon the first function return Devices with a JTAG interface have the JTAGEN fuse programmed by default This will make the respective port pins that are used for the J TAG interface un available for regular IO Back to FAQ Index 7 3 20 Why do all my foo bar strings eat up the SRAM By default all strings are handled as all other initialized variables they occupy RAM even though the compiler might warn you when it detects write attempts to these RAM locations and occupy the same amount of flash ROM so they can be initialized to the actual string by startup code The compiler can optimize multiple
99. c to change the behaviour of the mint8 option The current 2003 09 17 situation for mint8 is sizeof int 1 sizeof long 2 and sizeof long long 8 Note the absence of a 4 byte 32 bit type The patch proposes to change sozeof long long to be 4 bytes 32 bits When and if the patch is included in gcc we will need to change avr libc accordingly 8 bit types e typedef signed char int8_t e typedef unsigned char uint8_t 16 bit types e typedef int intl6_t e typedef unsigned int uint16_t 32 bit types e typedef long int32_t e typedef unsigned long uint32_t 64 bit types e typedef long long int64_t e typedef unsigned long long uint64_t Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 11 Integer Types 29 Pointer types These allow you to declare variables of the same size as a pointer e typedef int16_t intptr_t e typedef uint16_t uintptr_t 5 11 2 Typedef Documentation 5 11 2 1 typedef int int16_t 16 bit signed type 5 11 2 2 typedef long int32_t 32 bit signed type 5 11 2 3 typedef long long int64_t 64 bit signed type 5 11 2 4 typedef signed char int8_t 8 bit signed type 5 11 2 5 typedef int16_t intptr_t Signed pointer compatible type 5 11 2 6 typedef unsigned int uint16_t 16 bit unsigned type 5 11 2 7 typedef unsigned long uint32_t 32 bit unsigned type 5 11 2 8 typedef unsigned long long uint64_t 64 bit unsigned type 5 11 2 9 typedef unsigned char uint8_t
100. ce TWD 158 ay int uart_putchar char c if c n uart putchar Nr loop_until_bit_is_set UCSRA UDRE UDR c return 0 Note 5 Read len bytes from EEPROM starting at eeaddr into buf This requires two bus cycles during the first cycle the device will be selected master transmitter mode and the address transfered Address bits exceeding 256 are transfered in the E2 E1 E0 bits subaddress bits of the device selector The second bus cycle will reselect the device repeated start condition going into master receiver mode and transfer the data from the device to the TWI master Multiple bytes can be transfered by ACKing the client s transfer The last transfer will be NACKed which the client will take as an indication to not initiate further transfers int ee24xx_read_bytes uint1l6_t eeaddr int len uint8_t buf F F F FF F F F F F F F F uint8_t sla twcr n 0 int rv 0 patch high bits of EEPROM address into SLA sla TWI_SLA_24CXX eeaddr gt gt 8 amp 0x07 lt lt 1 Note 6 First cycle master transmitter mode SVA restart if n gt MAX_ITER return 1 begin TWCR _BV TWINT _BV TWSTA _BV TWEN send start condition while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_REP_START OK but should not happen case TW_START break Generated on Wed
101. connected to a TWI bus For the purpose of this example an EEPROM device out of the industry standard 24Cxx series has been chosen where xx can be one of 01 02 04 08 or 16 which are available from various vendors The choice was almost arbitrary mainly triggered by the fact that an EEPROM device is being talked to in both directions reading and writing the slave device so the example will demonstrate the details of both Usually there is probably not much need to add more EEPROM to an ATmega system that way the smallest possible AVR device that offers hardware TWI support is the ATmega8 which comes with 512 bytes of EEPROM which is equivalent to an 24C04 device The ATmegal28 already comes with twice as much EEPROM as the 24C16 would offer One exception might be to use an externally connected EEPROM device that is removable e g SDRAM PC memory comes with an integrated TWI EEPROM that carries the RAM configuration information 7 12 3 The Source Code THE BEER WARE LICENSE Revision 42 lt joerg FreeBSD ORG gt wrote this file As long as you retain this notice you can do whatever you want with this stuff If we meet some day and you think Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWI 156 this stuff is worth it you can buy me a beer in return Id twitest c v 1 1 2002 12 18 22 35 38 joerg_wunsch Exp Simple demo program that t
102. contention when one master starts to access the bus Normally the TWI bus interface unit will Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interface TWD 166 detect this situation and will not initiate a start condition while the bus is busy However in case two masters were starting at exactly the same time the way bus arbitration works there is always a chance that one master could lose arbitration of the bus during any transmit operation A master that has lost arbitration is required by the protocol to immediately cease talking on the bus in particular it must not initiate a stop condition in order to not corrupt the ongoing transfer from the active master In this example upon detecting a lost arbitration condition the entire transfer is going to be restarted This will cause a new start condition to be initiated which will normally be delayed until the currently active master has released the bus Note 8 Next the device slave is going to be reselected using a so called repeated start condition which is meant to guarantee that the bus arbitration will remain at the current master using the same slave address SLA but this time with read intent R 172W bit set to 1 in order to request the device slave to start transfering data from the slave to the master in the next packet Note 9 If the EEPROM device is still busy writing one or more cells after a previous write re
103. counter asm r3 some code asm volatile clr r3 more code The assembler instruction clr r3 will clear the variable counter AVR GCC will not completely reserve the specified register If the optimizer recognizes that the vari able will not be referenced any longer the register may be re used But the compiler is not able to check wether this register usage conflicts with any predefined register If you reserve too many registers in this way the compiler may even run out of registers during code generation In order to change the name of a function you need a prototype declaration because the compiler will not accept the asm keyword in the function definition Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 5 Using malloc 114 extern long Calc void asm CALCULATE Calling the function Calc will create assembler instructions to call the function CALCULATE 7 4 8 Links For a more thorough discussion of inline assembly usage see the gcc user manual The latest version of the gcc manual is always available here http gcc gnu org onlinedocs 7 5 Using malloc 7 5 1 Introduction On a simple device like a microcontroller implementing dynamic memory allocation is quite a challenge Many of the devices that are possible targets of avr libc have a minimal amount of RAM The smallest parts supported by the C environment come with 128 bytes of RAM This needs to be shared betwee
104. d Wl Map demo map to my link command Relink the application using the following command to generate demo map a portion of which is shown below avr gcc g mmcu at90s2313 Wl Map demo map o demo elf demo o Some points of interest in the demo map file are rela plt rela plt text 0x00000000 Oxca vectors vectors 0x00000000 ORIG 44 34 dobj avr ott1j etts2313 0 0x00000000 _ vectors 0x00000000 _ vector_default 0x00000016 _ ctors_start The text segment where program instructions are stored starts at location 0x0 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 151 Fin12 fan 1 Ea Gwen cu ee 0x000000ca _etext data 0x00800060 0x0 load address 0x000000ca 0x00800060 PROVIDE __data_start data gnu linkonce d 0x00800060 ALIGN 0x2 0x00800060 _edata 0x00800060 PROVIDE __data_end bss 0x00800060 0x3 0x00800060 PROVIDE __bss_start bss COMMON COMMON 0x00800060 0x3 demo o 0x0 size before relaxing 0x00800060 direction 0x00800061 pwm 0x00800063 PROVIDE __bss_end 0x000000ca _ data_load_start LOADADDR data 0x000000ca _ data_load_end __data_load_start SIZEOF data noinit 0x00800063 0x0 0x00800063 PROVIDE __noinit_start U TRE 0x00800063 PROVIDE __noinit_end 0x00800063 _end 0x00800063 PROVIDE __heap_start eeprom 0x00810000 0x0 load address 0x000000ca eeprom 0x008100
105. de lt string h gt The string functions perform string operations on NULL terminated strings Note If the strings you are working on resident in program space flash you will need to use the string functions described in Program Space String Utilities Functions void x memccpy void x const void x int size_t void x memchr const void x int size_t _ATTR_PURE_ int memcmp const void const void x size_t _ATTR PURE__ void x memcpy void const void x size_t void x memmove void x const void x size_t void x memset void x int size_t int strcasecmp const char x const char x _ATTR PURE__ char x strcat char x const char char x strchr const char x int _ATTR PURE__ int strcmp const char const char x _ATTR_PURE_ char strcpy char const char size_t strlcat char x const char size_t size_t strlcpy char const char size_t size_t strlen const char x _ATTR_PURE__ char x strlwr char int strncasecmp const char x const char x size_t _ATTR PURE__ char x strncat char x const char size_t int strncmp const char const char x size_t char strncpy char x const char size_t size_t strnlen const char x size_t _ATTR PURE__ char x strrchr const char x int _ATTR_PURE_ Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 62 char x strrev char x char strsep char xx const char x _ATTR_PURE__ char strstr const char x co
106. direction DOWN break case DOWN if pwm 0 3e 80 91 61 00 lds r24 0x0061 42 90 91 62 00 lds r25 0x0062 46 01 97 sbiw r24 0x01 48 90 93 62 00 sts 0x0062 r25 4c 80 93 61 00 sts 0x0061 r24 50 80 91 61 00 lds r24 0x0061 54 90 91 62 00 lds r25 0x0062 58 89 2b or r24 r25 5a b1 4 brne 44 direction UP DE 10 92 60 00 sts 0x0060 r1 60 13 60 rjmp 38 62 80 91 61 00 lds r24 0x0061 66 90 91 62 00 lds r25 0x0062 6a 01 96 adiw r24 0x01 6c 90 93 62 00 sts 0x0062 r25 70 80 93 61 00 sts 0x0061 r24 74 80 91 61 00 lds r24 0x0061 78 90 91 62 00 lds x25 0x0062 TE 8f 5f subi r24 OxFF Te 93 40 sbci r25 0x03 80 19 4 brne 6 82 81 e0 ldi r24 0x01 61 Oxbe 63 0x62 0x88 0x88 0x88 255 0x88 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 149 84 80 93 60 00 sts 0x0060 r24 break OCR pwm Note 4 88 80 91 61 00 lds r24 0x0061 8c 90 91 62 00 lds r25 0x0062 90 9b bd out Ox2b r25 p43 92 3 8a bd out Ox2a r24 pp AZ 94 9f 9 pop r25 96 BL 8 pop r24 98 Zits 9 pop r18 9a Of 90 pop ro 96 Of be out Ox3f r0 4 63 9e Of 90 pop ro ad 1f 90 pop rl a2 18 95 reti 000000a4 lt ioinit gt void ioinit void Note 5 tmrl is 10 bit PWM TCCRIA _BV PWM10 _BV PWM11 _BV XCOM11 a4 83 e8 ldi r24 0x83 131 a6 8f bd out Ox2f r24 AT tmrl running on full MCU c
107. e If this was a real product we d probably put a SLEEP instruction in this loop to conserve power Note 7 Early AVR devices saturate their outputs at rather low currents when sourcing cur rent so the LED can be connected directly the resulting current through the LED will be about 15 mA For modern parts at least for the ATmega 128 however Atmel has drastically increased the IO source capability so when operating at 5 V Vcc R2 is needed Its value should be about 150 Ohms When operating the circuit at 3 V it can still be omitted though 7 11 2 The Source Code gt lt a gL RE 2 F F F THE BEER WARE LICENSE Revision 42 lt joerg FreeBSD ORG gt wrote this file As long as you retain this notice you can do whatever you want with this stuff If we meet some day and you think this stuff is worth it you can buy me a beer in return Joerg Wunsch Simple AVR demonstration Controls a LED that can be directly connected from OC1 0C1A to GND The brightness of the LED is controlled with the PWM After each period of the PWM the PWM value is either incremented or decremented that s all SId demo c v 1 1 2002 09 30 18 16 07 troth Exp 2 include lt inttypes h gt include lt avr io h gt include lt avr interrupt h gt include lt avr signal h gt if defined _ _AVR_AT90S2313__ define OC1 PB3 define OCR OCRI define DDROC DDRB elif defined _ AVR_AT90S2333__
108. e _SFR_OFFSET definition is not used in any way in this case Define _SFR_ASM_COMPAT as 1 to make these names work as simple constants ad dresses of the I O registers This is necessary when included in preprocessed assem bler S source files so it is done automatically if _ASSEMBLER__ is defined By default all addresses are defined as if they were memory addresses used in lds sts instructions To use these addresses in in out instructions you must subtract 0x20 from them For more backwards compatibility insert the following at the start of your old assem bler source file define __SFR_OFFSET 0 This automatically subtracts 0x20 from I O space addresses but it s a hack so it is recommended to change your source wrap such addresses in macros defined here as shown below After this is done the __SFR_OFF SET definition is no longer necessary and can be removed Real example this code could be used in a boot loader that is portable between devices with SPMCR at different addresses lt avr iom163 h gt define SPMCR _SFR_IO8 0x37 lt avr iom128 h gt define SPMCR _SFR_MEM8 0x68 if _SFR_IO_REG_P SPMCR out _SFR_IO_ADDR SPMCR r24 else sts _SFR_MEM_ADDR SPMCR r24 endif You can use the in out cbi sbi sbic sbis instructions without the _SFR_ IO_REG_P test if you know that the register is in the I O space as with SREG for example If it isn t the assembler will complain I O add
109. e files already contain the appropriate line number information from the C source files Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 10 Using the GNU tools 140 e a cdhlmns file Turn on the assembler listing The sub options are c omit false conditionals domit debugging directives h include high level source 1 include assembly minclude macro expansions n omit forms processing s include symbols file set the name of the listing file The various sub options can be combined into a single a option list file must be the last one in that case 7 10 2 2 Examples for assembler options passed through the C compiler Re member that assembler options can be passed from the C compiler frontend using Wa see above so in order to include the C source code into the assembler listing in file foo 1st when compiling foo c the following compiler command line can be used avr gcc c O foo c o foo o Wa ahls f00 lst In order to pass an assembler file through the C preprocessor first and have the assem bler generate line number debugging information for it the following command can be used avr gcc c x assembler with cpp o foo o foo S Wa gstabs Note that on Unix systems that have case distinguishing file systems specifying a file name with the suffix S upper case letter S will make the compiler automatically assume x assembler with cpp while usin
110. e initial portion of the string pointed to by st ringp to integer representation It is equivalent to strtol nptr char NULL 10 except that atol does not detect errors Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 54 5 15 4 5 void bsearch const void _key const void _base size_t _nmemb size_t __size int x __compar const void x const void The bsearch function searches an array of nmemb objects the initial member of which is pointed to by base for a member that matches the object pointed to by key The size of each member of the array is specified by size The contents of the array should be in ascending sorted order according to the compar ison function referenced by compar The compar routine is expected to have two arguments which point to the key object and to an array member in that order and should return an integer less than equal to or greater than zero if the key object is found respectively to be less than to match or be greater than the array member The bsearch function returns a pointer to a matching member of the array or a null pointer if no match is found If two members compare as equal which member is matched is unspecified 5 15 4 6 void calloc size_t __nele size_t __size Allocate nele elements of size each Identical to calling malloc using nele size as argument except the allocated memory will be cleared to zero
111. e its code path analysis shows that nothing inside the loop could change the value of flag anyway To tell the compiler that this variable could be changed outside the scope of its code path analysis e g from within an interrupt routine the variable needs to be declared like volatile uint8_t flag Back to FAQ Index 7 3 3 I get undefined reference to for functions like sin In order to access the mathematical functions that are declared in lt math h gt the linker needs to be told to also link the mathematical library Libm a Typically system libraries like 1ibm a are given to the final C compiler command line that performs the linking step by adding a flag 1m at the end That is the initial lib and the filename suffix from the library are written immediately after a flag So for a libfoo a library 1foo needs to be provided This will make the linker search the library in a path known to the system An alternative would be to specify the full path to the 1ibm a file at the same place on the command line i e after all the object files gt o However since this re quires knowledge of where the build system will exactly find those library files this is deprecated for system libraries Back to FAQ Index 7 3 4 How to permanently bind a variable to a register This can be done with register unsigned char counter asm r3 See C Names Used in Assembler Code for more details Back to FAQ Index 7 3
112. e referenced by a percent sign followed by a single digit 0 refers to the first 1 to the second operand and so forth From the above example 0 refers to r value and 1 refers to I PORTD This may still look a little odd now but the syntax of an operand list will be explained soon Let us first examine the part of a compiler listing which may have been generated from our example lds r24 value APP in r24 12 NOAPP sts value r24 The comments have been added by the compiler to inform the assembler that the in cluded code was not generated by the compilation of C statements but by inline as sembler statements The compiler selected register r24 for storage of the value read from PORTD The compiler could have selected any other register though It may not explicitely load or store the value and it may even decide not to include your assembler code at all All these decisions are part of the compiler s optimization strategy For example if you never use the variable value in the remaining part of the C program the compiler will most likely remove your code unless you switched off optimization To avoid this you can add the volatile attribute to the asm statement asm volatile in 0 1 r value I PORTD The last part of the asm instruction the clobber list is mainly used to tell the compiler about modifications done by the assembler code This part may be omitted all other parts are re
113. e signed fractional part of value 5 12 3 20 double pow double __x double _y The function pow returns the value of x to the exponent y 5 12 3 21 double sin double _x The sin function returns the sine of x measured in radians Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 13 Setjmp and Longjmp 34 5 12 3 22 double sinh double _x The sinh function returns the hyperbolic sine of x 5 12 3 23 double sqrt double __x The sqrt function returns the non negative square root of x 5 12 3 24 double square double _x The function square returns x x Note This function does not belong to the C standard definition 5 12 3 25 double tan double _x The tan function returns the tangent of x measured in radians 5 12 3 26 double tanh double __x The tanh function returns the hyperbolic tangent of x 5 13 Setjmp and Longjmp 5 13 1 Detailed Description While the C language has the dreaded goto statement it can only be used to jump to a label in the same local function In order to jump directly to another non local function the C library provides the setjmp and longjmp functions setjmp and longjmp are useful for dealing with errors and interrupts encountered in a low level subroutine of a program Note setimp and longjmp make programs hard to understand and maintain If possi ble an alternative should be used For a very detailed discussio
114. e since avr gdb needs one of these to run as a a remote target backend 7 8 9 Simulavr Simulavr also uses the configure system so to build and install gunzip c simulavr lt version gt tar gz tar xf cd simulavr lt version gt mkdir obj avr cd obj avr configure prefix PREFIX make make install LR LH Ln LR L nw Note You might want to have already installed avr binutils avr gcc and avr libe if you want to have the test programs built in the simulavr source 7 8 10 AVaRice Note These install notes are not applicable to avarice 1 5 or older You probably don t want to use anything that old anyways since there have been many improvements and bug fixes since the 1 5 release AVaRice also uses the configure system so to build and install gunzip c avarice lt version gt tar gz tar xf cd avarice lt version gt mkdir obj avr cd obj avr configure prefix PREFIX make make install Le LB ZB ZF B ZA 40 Note AVaRice uses the bfd library for accessing various binary file formats You may need to tell the configure script where to find the lib and headers for the link to work This is usually done by invoking the configure script like this Replace lt hdr_path gt with the path to the bfd h file on your system Replace lt 1ib_ path gt with the path to lLibbfd a on your system CPPFLAGS I lt hdr_path gt LDFLAGS L lt lib_path gt configure prefix PREFIX Generated o
115. e value too but the compiler didn t update the memory location for optimization reasons The worst thing you can do in this case is uint8_t s asm volatile in 30 _ SREG__ TANET neri TN ET ld _ tmp_reg__ al TANTI inc tmp r g T PNA st Sal __tmp_reg__ n t out __SREG__ 0 TANEM amp r s e ptr memory The special clobber memory informs the compiler that the assembler code may mod ify any memory location It forces the compiler to update all variables for which the contents are currently held in a register before executing the assembler code And of course everything has to be reloaded again after this code In most situations a much better solution would be to declare the pointer destination itself volatile volatile uint8_t ptr This way the compiler expects the value pointed to by ptr to be changed and will load it whenever used and store it whenever modified Situations in which you need clobbers are very rare In most cases there will be better ways Clobbered registers will force the compiler to store their values before and reload them after your assembler code Avoiding clobbers gives the compiler more freedom while optimizing your code 7 4 5 Assembler Macros In order to reuse your assembler language parts it is useful to define them as macros and put them into include files AVR Libc comes with a bunch of them which could be found in the directory avr include Using such include
116. early see that 0x0038 is correctly passed for the address of the io port Looking at the disassembled object code for the body of the function we can see that the function is indeed performing the operation we intended void set_bits_func_correct volatile uint8_t port uint8_t mask 8 fc 01 movw r30 r24 port mask fa 80 81 ld r24 Z EE 86 2b or r24 r22 fe 80 83 st Z r24 100 08 95 ret Notice that we are accessing the io port via the LD and ST instructions The port parameter must be volatile to avoid a compiler warning Note Because of the nature of the IN and OUT assembly instructions they can not be used inside the function when passing the port in this way Readers interested in the details should consult the Instruction Set data sheet Finally we come to the macro version of the operation In this contrived example the macro is the most efficient method with respect to both execution speed and code size set_bits_macro PORTB Oxf0 llc 88 b3 in r24 0x18 s 24 lle 80 6f ori r24 OxFO 240 120 88 bb out 0x18 r24 24 Of course in a real application you might be doing a lot more in your function which uses a passed by reference io port address and thus the use of a function over a macro could save you some code space but still at a cost of execution speed Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 95 Care should be taken when such
117. east the state of the flag bits in SREG Note that this serves as an example here only since actually all the following instructions would not modify SREG either but that s not commonly the case Also it must be made sure that registers used inside the interrupt routine do not conflict with those used outside In the case of a RAM less device like the AT90S1200 this can only be done by agreeing on a set of registers to be used exclusively inside the interrupt routine there would not be any other chance to save a register anywhere If the interrupt routine is to be linked together with C modules care must be taken to follow the register usage guidelines imposed by the C compiler Also any register modified inside the interrupt sevice needs to be saved usually on the stack Note 10 As explained in Interrupts and Signals a global catch all interrupt handler that gets all unassigned interrupt vectors can be installed using the name _ vector_ default This must be global and obviously should end in a ret i instruc tion By default a jump to location 0 would be implied instead 7 3 Frequently Asked Questions 7 3 1 FAQ Index 1 My program doesn t recognize a variable updated within an interrupt routine 2 I get undefined reference to for functions like sinQ 3 How to permanently bind a variable to a register Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequen
118. eprom_read_block 11 eeprom_read_byte 11 eeprom_read_word 12 eeprom_rw 11 eeprom_wb 11 eeprom_write_block 12 eeprom_write_byte 12 eeprom_write_word 12 avr_errno EDOM 27 ERANGE 27 avr_interrupts cli 72 EMPTY INTERRUPT 72 INTERRUPT 72 sei 72 SIGNAL 72 timer_enable_int 73 avr_inttypes int16_t 28 INDEX 170 int32_t 28 pgm_read_word_near 15 int64_t 28 PGM_VOID_P 15 int8_t 28 PRG_RDB 15 intptr_t 28 PSTR 16 uint16_t 28 strcasecmp_P 16 uint32_t 29 strcat_P 16 uint64_t 29 stremp_P 16 uint8_t 29 strepy_P 17 uintptr_t 29 strlcat_P 17 avr_math strlepy_P 17 acos 30 strlen_P 17 asin 30 strncasecmp_P 18 atan 31 strncat_P 18 atan2 31 strncmp_P 18 ceil 31 strncpy_P 18 cos 31 avr_sfr cosh 31 _BV 75 exp 31 bit_is_clear 75 fabs 31 bit_is_set 75 floor 31 BV 75 fmod 31 cbi 76 frexp 32 inb 76 inverse 32 inp 76 isinf 32 inw 76 isnan 32 loop_until_bit_is_clear 76 Idexp 32 loop_until_bit_is_set 77 log 32 outb 77 log 10 32 sbi 78 M_PI 30 avr_sleep M_SQRT2 30 set_sleep_mode 21 modf 33 sleep_mode 21 pow 33 SLEEP MODE ADC 21 sin 33 SLEEP MODE EXT sinh 33 STANDBY 21 sqrt 33 SLEEP MODE IDLE 21 square 33 SLEEP _ MODE PWR DOWN tan 33 21 tanh 33 SLEEP MODE PWR SAVE 21 avr_pgmspace SLEEP_MODE_STANDBY 21 memcpy_P 16 avr_stdio PGM_P 14 clearerr 40 pgm_read_byte 14 EOF 39 pgm read vte far 14 fclose 40 pgm read_byte_near 15 fdevo
119. er the EEPROMs are only capable of writing one page simultaneously so care must be taken to not cross a page boundary within one write cycle The amount of data one page consists of varies from manufacturer to manufacturer some vendors only use 8 byte pages for the smaller devices and 16 byte pages for the larger devices while other vendors generally use 16 byte pages We thus use the smallest common denominator of 8 bytes per page declared by the macro PAGE_SIZE above The function simply returns after writing one page returning the actual number of data byte written It is up to the caller to re invoke it in order to write further data E E ee i E A ARE SE a E E a IRE ae HE int ee24xx_write_page uint1l6_t eeaddr int len uint8_t buf uint8_t sla n 0 int rv 0 uint16_t endaddr if eeaddr len lt eeaddr PAGE_SIZE 1 endaddr eeaddr len else endaddr eeaddr PAGE_SIZE 1 1 len endaddr eeaddr patch high bits of EEPROM address into SLA sla TWI_SLA_24CXX eeaddr gt gt 8 amp 0x07 lt lt 1 restart if n gt MAX_ITER return 1 begin Note 13 TWCR _BV TWINT _BV TWSTA _BV TWEN send start condition while TWCR amp _BV TWINT 0 wait for transmission switch twst TW_STATUS case TW_REP_START OK but should not happen case TW_START Generated on Wed Nov 26 21 10 23 2003 for avr libc by
120. er is too small you risk a buffer overflow Conversion is done using the radix as base which may be a number between 2 binary conversion and up to 36 If radix is greater than 10 the next digit after 9 will be the letter a If radix is 10 and val is negative a minus sign will be prepended The itoa function returns the pointer passed as s Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 56 5 15 4 13 long labs long _i The labs function computes the absolute value of the long integer i Note The abs and labs functions are builtins of gcc 5 15 4 14 Idiv_t Idiv long __num long _denom The ldiv function computes the value num denom and returns the quotient and re mainder in a structure named 1div_t that contains two long integer members named quot and rem 5 15 4 15 charx Itoa long int __val char gt __s int __radix Convert a long integer to a string The function Itoa converts the long integer value from val into an ASCII represen tation that will be stored under s The caller is responsible for providing sufficient storage in s Note The minimal size of the buffer s depends on the choice of radix For example if the radix is 2 binary you need to supply a buffer with a minimal length of 8 sizeof long int characters i e one character for each bit plus one for the string terminator Using a larger radix will require a smaller minimal buff
121. er size Warning If the buffer is too small you risk a buffer overflow Conversion is done using the radix as base which may be a number between 2 binary conversion and up to 36 If radix is greater than 10 the next digit after 9 will be the letter a If radix is 10 and val is negative a minus sign will be prepended The ltoa function returns the pointer passed as s 5 15 4 16 void malloc size_t __size The malloc function allocates size bytes of memory If malloc fails a NULL pointer is returned Note that malloc does not initialize the returned memory to zero bytes See the chapter about malloc usage for implementation details Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 57 5 15 4 17 void qsort void _base size_t _nmemb size_t _ size _compar_fn_t _compar The qsort function is a modified partition exchange sort or quicksort The qsort function sorts an array of nmemb objects the initial member of which is pointed to by base The size of each object is specified by size The contents of the array base are sorted in ascending order according to a comparison function pointed to by compar which requires two arguments pointing to the objects being compared The comparison function must return an integer less than equal to or greater than zero if the first argument is considered to be respectively less than equal to or greater than the
122. er than zero if sl is found respectively to be less than to match or be greater than s2 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 64 5 16 2 8 char x strcat char x dest const char src Concatenate two strings The strcat function appends the src string to the dest string overwriting the 0 char acter at the end of dest and then adds a terminating 0 character The strings may not overlap and the dest string must have enough space for the result Returns The strcat function returns a pointer to the resulting string dest 5 16 2 9 char x strchr const char x src int val Locate character in string The strchr function returns a pointer to the first occurrence of the character val in the string src Here character means byte these functions do not work with wide or multi byte characters Returns The strchr function returns a pointer to the matched character or NULL if the character is not found 5 16 2 10 int stremp const char x s1 const char s2 Compare two strings The stremp function compares the two strings sl and s2 Returns The stremp function returns an integer less than equal to or greater than zero if sl is found respectively to be less than to match or be greater than s2 5 16 2 11 char strcpy char x dest const char src Copy a string The strcpy function copies the string pointed to by src including the te
123. ers OCRnM Refer to the actual datasheet for each device s set of registers that involves the TEMP register When accessing one of the registers that use TEMP from the main application and possibly any other one from within an interrupt routine care must be taken that no access from within an interrupt context could clobber the TEMP register data of an in progress transaction that has just started elsewhere To protect interrupt routines against other interrupt routines it s usually best to use the Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions SIGNAL macro when declaring the interrupt function and to ensure that interrupts are still disabled when accessing those 16 bit timer registers Within the main program access to those registers could be encapsulated in calls to the cliQ and sei macros If the status of the global interrupt flag before accessing one of those registers is uncertain something like the following example code can be used uint16_t read_timerl void uint8_t sreg uint16_t val sreg SREG cli val TCNT1 SREG sreg return val Back to FAQ Index 7 3 10 How do I use a define d constant in an asm statement So you tried this asm volatile sbi 0x18 0x07 Which works When you do the same thing but replace the address of the port by its macro name like this asm volatile sbi PORTB 0x07 you get a compilation e
124. ers no terminating NUL is added The usual skip of leading white space is suppressed To skip white space first use an explicit space in the format Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 49 e Matches a nonempty sequence of characters from the specified set of accepted characters the next pointer must be a pointer to char and there must be enough room for all the characters in the string plus a terminating NUL character The usual skip of leading white space is suppressed The string is to be made up of characters in or not in a particular set the set is defined by the characters between the open bracket character and a close bracket character The set excludes those characters if the first character after the open bracket is a circum flex To include a close bracket in the set make it the first character after the open bracket or the circumflex any other position will end the set The hyphen character is also special when placed between two other characters it adds all intervening characters to the set To include a hyphen make it the last character before the final close bracket For instance 0 9 means the set of every thing except close bracket zero through nine and hyphen The string ends with the appearance of a character not in the or with a circumflex in set or when the field width runs out e p Matches a pointer value as printed by p in p
125. es can clobber any of them the caller is responsible for saving and restoring Call saved registers r2 r17 r28 r29 May be allocated by gcc for local data Calling C subroutines leaves them un changed Assembler subroutines are responsible for saving and restoring these registers if changed r29 r28 Y pointer is used as a frame pointer points to local data on stack if necessary e Fixed registers r0 r1 Never allocated by gcc for local data but often used for fixed purposes rO temporary register can be clobbered by any C code except interrupt han dlers which save it may be used to remember something for a while within one piece of assembler code rl assumed to be always zero in any C code may be used to remember some thing for a while within one piece of assembler code but must then be cleared Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 96 afteruse clr r1 This includes any use of the mul s u instructions which return their result in rl r0 Interrupt handlers save and clear r1 on entry and restore rl on exit in case it was non zero e Function call conventions Arguments allocated left to right r25 to r8 All arguments are aligned to start in even numbered registers odd sized arguments including char have one free register above them This allows making better use of the movw instruction on the enhanced core If too many those th
126. es the stack pointer by default to point to the last avaialable address in internal SRAM Thus the region between _end and the end of SRAM is what is available for stack If your application uses malloc which e g also can happen inside printf the heap for dynamic memory is also located there See Using malloc The amount of stack required for your application cannot be determined that easily For example if you recursively call a function and forget to break that recursion the amount of stack required is infinite You can look at the generated assembler code avr gcc S there s a comment in each generated assembler file that tells you the frame size for each generated function That s the amount of stack required for this function you have to add up that for all functions where you know that the calls could be nested Back to FAQ Index 7 4 Inline Asm AVR GCC Inline Assembler Cookbook About this Document The GNU C compiler for Atmel AVR RISC processors offers to embed assembly language code into C programs This cool feature may be used for manually optimizing time critical parts of the software or to use specific processor instruction which are not available in the C language Because of a lack of documentation especially for the AVR version of the compiler it may take some time to figure out the implementation details by studying the compiler and assembler source code There are also a few sample prog
127. essor The GNU Binutils suite is made up of many useful tools for manipulating object files that get generated One tool is avr objdump which takes information from the object file and displays it in many useful ways Typing the command by itself will cause it to list out its options Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 147 For instance to get a feel of the application s size the h option can be used The output of this option shows how much space is used in each of the sections the st ab and stabstr sections hold the debugging information and won t make it into the ROM file An even more useful option is S This option disassembles the binary file and inter sperses the source code in the output This method is much better in my opinion than using the S with the compiler because this listing includes routines from the libraries and the vector table contents Also all the fix ups have been satisfied In other words the listing generated by this option reflects the actual code that the processor will run avr objdump h S demo elf gt demo lst Here s the output as saved in the demo 1st file demo elf file format elf32 avr Sections Idx Name Size VMA LMA File off Algn 0 text 000000ca 00000000 00000000 00000094 2 0 CONTENTS ALLOC LOAD READONLY CODE 1 data 00000000 00800060 000000ca 0000015e 2 0 CONTENTS ALLOC LOAD DATA 2 DSS 00000003
128. f demo hex The resulting demo hex file contains 00000000AC062C061C0 60CO05FCOO0ACO5DCO5CCOA1 00010005BC05AC059C011241FBECFEDCDBF4EC02A 2100020001 F920F 920FB60F9211242F938F939F93CD 100030008091600099270097A1F0019729F58091A0 0004000610090916200019790936200809361003B 00050008091610090916200892BB1F41092600050 1000600013C08091610090916200019690936200AC 100070008093610080916100909162008F5F934056 000800019F481E08093600080916100909162009A 00090009BBD8ABD9F918F912F910F900FBEOF90A6 1000A0001F90189583E88FBD81E08EBD1BBC1ABCE4 000B00088E087BB80E889BF 789408 95CFEDDOEOD1 0A00COOODEBFCDBFEFDFFFCF9BCF07 00000001FF The j option indicates that we want the information from the text and data segment extracted If we specify the EEPROM segment we can generate a hex file that can be used to program the EEPROM avr objcopy j eeprom change section ilma The resulting demo_eeprom hex file contains 00000001FF eeprom 0 O ihex demo elf demo_eeprom hex which is an empty hex file which is expected since we didn t define any EEPROM variables 7 11 7 Make Build the Project Rather than type these commands over and over they can all be placed in a make file To build the demo project using make save the following in a file called Makefile Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 153 Note This Makefile can only be used as input for the GNU version of make PRG
129. f the value and ERANGE is stored in errno If the correct value would cause underflow zero is returned and ERANGE is stored in errno FIXME HUGE_VAL needs to be defined somewhere The bit pattern is Ox7fffffff but what number would this be 5 15 4 25 long strtol const char _nptr char xx _endptr int _base The strtol function converts the string in nptr to a long value The conversion is done according to the given base which must be between 2 and 36 inclusive or be the special value 0 The string may begin with an arbitrary amount of white space as determined by iss pace followed by a single optional or sign If base is zero or 16 the string may then include a 0x prefix and the number will be read in base 16 otherwise a zero base is taken as 10 decimal unless the next character is 0 in which case it is taken as 8 octal Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 59 The remainder of the string is converted to a long value in the obvious manner stopping at the first character which is not a valid digit in the given base In bases above 10 the letter A in either upper or lower case represents 10 B represents 11 and so forth with Z representing 35 If endptr is not NULL strtol stores the address of the first invalid character in endptr If there were no digits at all however strtol stores the origin
130. f this function is to delay the program execution by a specified number of milliseconds using a counting loop The global 16 bit variable delay_count must contain the CPU clock frequency in Hertz divided by 4000 and must have been set before calling this routine for the first time As described in the clobber section the routine uses a local variable to hold a temporary value Another use for a local variable is a return value The following function returns a 16 bit value read from two successive port addresses Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 113 uint16_t inw uint8_t port uint16_t result asm volatile in SAD SI Manje in BO 1 1 r result I port i return result Note inw is supplied by avr libc 7 4 7 C Names Used in Assembler Code By default AVR GCC uses the same symbolic names of functions or variables in C and assembler code You can specify a different name for the assembler code by using a special form of the asm statement unsigned long value asm clock 3686400 This statement instructs the compiler to use the symbol name clock rather than value This makes sense only for external or static variables because local variables do not have symbolic names in the assembler code However local variables may be held in registers With AVR GCC you can specify the use of a specific register void Count void register unsigned char
131. fclose FILE __stream int vfprintf FILE _ stream const char __fmt va_list __ap int vfprintf_P FILE __stream const char x__fmt va_list __ap int fputc int __c FILE x__stream int printf const char x__fmt int printf_P const char x__fmt int sprintf char x__s const char __fmt int sprintf_P char x__s const char __fmt int snprintf char __s size_t __n const char x__fmt Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 39 int snprintf_P char __s size_t _n const char __fmt int vsprintf char __s const char __fmt va_list ap int vsprintf_P char __s const char __fmt va_list ap int vsnprintf char x__s size_t _n const char __fmt va_list ap int vsnprintf_P char __s size_t _n const char __fmt va_list ap int fprintf FILE __stream const char __fmt int fprintf_P FILE Stream const char __fmt int fputs const char __str FILE __stream int fputs_P const char __str FILE __stream int puts const char __str int puts_P const char __str size_t fwrite const void __ptr size_t __size size_t _nmemb FILE __stream int fgetc FILE __stream int ungetc int __c FILE __stream char fgets char __str int __size FILE __stream char gets char __str size_t fread void __ptr size_t __size size_t _nmemb FILE __stream void clearerr FILE __stream int feof FILE x__strea
132. fies that the argument for the d i 0 u x or X conversion isa long int rather than int e A character that specifies the type of conversion to be applied The conversion specifiers and their meanings are e diouxX The int or appropriate variant argument is converted to signed deci mal d and i unsigned octal 0 unsigned decimal u or unsigned hexadecimal x and X notation The letters abcdef are used for x conversions the letters ABCDEF are used for X conversions The precision if any gives the mini mum number of digits that must appear if the converted value requires fewer digits it is padded on the left with zeros e p The void x argument is taken as an unsigned integer and converted similarly as a x command would do e c The int argument is converted to an unsigned char and the resulting character is written e s The char x argument is expected to be a pointer to an array of character type pointer to a string Characters from the array are written up to but not including a terminating NUL character if a precision is specified no more than the number specified are written If a precision is given no null character need be present if the precision is not specified or is greater than the size of the array the array must contain a terminating NUL character e 3A is written No argument is converted The complete conversion specifica tion is 9 e cE The double argument is rounded and conver
133. file possibly one that has to be passed through the C preprocessor it s the assembler that needs to be told to include line number information into the output file Other debug information like data types and variable allocation cannot be generated since unlike a compiler the assembler basically doesn t know about this This is done using the GNU assembler option gstabs Example Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 92 avr as mmcu atmegal28 gstabs o foo o foo s When the assembler is not called directly but through the C compiler frontend either implicitly by passing a source file ending in S or explicitly using x assembler with cpp the compiler frontend needs to be told to pass the gstabs option down to the assembler This is done using Wa gstabs Please take care to only pass this option when compiling an assembler input file Oth erwise the assembler code that results from the C compilation stage will also get line number information which confuses the debugger Note You can also use Wa gstabs since the compiler will add the extra for you Example EXTRA_OPTS Wall mmcu atmegal28 x assembler with cpp avr gcc Wa gstabs EXTRA_OPTS c o foo o foo S Also note that the debugger might get confused when entering a piece of code that has a non local label before since it then takes this label as the name of a
134. flow0 Interrupt Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 17 Interrupts and Signals 71 Signal Name Description SIG_OVERFLOW1 Overflow1 Interrupt SIG_OVERFLOW2 Overflow2 Interrupt SIG_OVERFLOW3 Overflow3 Interrupt SIG_PIN SIG_PIN CHANGEO SIG_PIN_CHANGE1 SIG_RDMAC SIG_SPI SPI Interrupt SIG_SPM_READY Store program memory ready SIG_SUSPEND_RESUME SIG_TDMAC SIG_UARTO SIG_UARTO_DATA UART 0 Data Register Empty Interrupt SIG_UARTO_RECV UART 0 Receive Complete Interrupt SIG_UARTO_TRANS UART 0 Transmit Complete Interrupt SIG_UART1 SIG_UART1_DATA UART 1 Data Register Empty Interrupt SIG_UART1_RECV UART 1 Receive Complete Interrupt SIG_UART1_TRANS UART 1 Transmit Complete Interrupt SIG_UART_DATA UART Data Register Empty Interrupt SIG_UART_RECV UART Receive Complete Interrupt SIG_UART_TRANS UART Transmit Complete Interrupt SIG_USARTO_DATA USART 0 Data Register Empty Interrupt SIG_USART0_RECV USART 0 Receive Complete Interrupt SIG_USARTO_TRANS USART 0 Transmit Complete Interrupt SIG_USART1_DATA USART 1 Data Register Empty Interrupt SIG_USART1_RECV USART 1 Receive Complete Interrupt SIG_USART1_TRANS USART 1 Transmit Complete Interrupt SIG_USB_HW Global manipulation of the interrupt flag The global interrupt flag is maintained in the I bit of the status register SREG e define
135. fscanf_P avr_stdio 49 vsnprintf avr_stdio 49 vsnprintf_P avr_stdio 49 vsprintf avr_stdio 49 vsprintf_P avr_stdio 49 Watchdog timer handling 22 wdt_disable avr_watchdog 22 wdt_enable avr_watchdog 22 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 178 wdt_reset avr_watchdog 23 WDTO_120MS avr_watchdog 23 WDTO_15MS avr_watchdog 23 WDTO_1S avr_watchdog 23 WDTO_250MS avr_watchdog 23 WDTO_2S avr_watchdog 23 WDTO_30MS avr_watchdog 23 WDTO_500MS avr_watchdog 23 WDTO_60MS avr_watchdog 24 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen
136. g 63 strcat_P avr_pgmspace 16 strchr avr_string 63 strcmp avr_string 63 strcmp_P avr_pgmspace 16 strcpy avr_string 64 strepy P avr_pgmspace 17 Strings 60 strlcat avr_string 64 strlcat_P avr_pgmspace 17 strlcpy avr_string 64 strlcpy_P avr_pgmspace 17 strlen avr_string 64 strlen_P avr_pgmspace 17 strlwr avr_string 65 strncasecmp Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 177 avr_string 65 strncasecmp_P avr_pgmspace 18 strncat avr_string 65 strncat_P avr_pgmspace 18 strncmp avr_string 65 strnemp_P avr_pgmspace 18 strncpy avr_string 66 strncpy_P avr_pgmspace 18 strnlen avr_string 66 strrchr avr_string 66 strrev avr_string 67 strsep avr_string 67 strstr avr_string 67 strtod avr_stdlib 57 strtok_r avr_string 67 strtol avr_stdlib 58 strtoul avr_stdlib 58 strupr avr_string 68 supported devices 1 System Errors errno 26 tan avr_math 33 tanh avr_math 33 timer_enable_int avr_interrupts 73 toascii ctype 26 tolower ctype 26 tools optional 127 tools required 127 toupper ctype 26 uint16_t avr_inttypes 28 uint32_t avr_inttypes 29 uint64_t avr_inttypes 29 uint8_t avr_inttypes 29 uintptr_t avr_inttypes 29 ultoa avr_stdlib 59 ungetc avr_stdio 44 utoa avr_stdlib 59 vfprintf avr_stdio 44 vfprintf_P avr_stdio 47 vfscanf avr_stdio 47 v
137. g s would pass the file directly to the assembler no preprocessing done 7 10 3 Controlling the linker avr 1d 7 10 3 1 Selected linker options While there are no machine specific options for avr ld a number of the standard options might be of interest to AVR users e lname Locate the archive library named libname a and use it to resolve currently unresolved symbols from it The library is searched along a path that con sists of builtin pathname entries that have been specified at compile time e g usr local avr lib on Unix systems possibly extended by path name entries as specified by L options that must precede the 1 options on the command line Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 10 Using the GNU tools 141 Lpath Additional location to look for archive libraries requested by 1 options defsym symbol expr Define a global symbol symbol using expr as the value M Print a linker map to stdout Map mapfile Print a linker map to mapfile cref Output a cross reference table to the map file in case Map is also present or to stdout section start sectionname org Start section sectionname at absolute address org Tbss org e Tdata org Ttext org Start the bss data or text section at org respectively T scriptfile Use scriptfile as the linker script replacing the default linker script De fault linker scripts are
138. h gt outbh PORTA 0x33 or they can assign a value directly to the symbolic address PORTA 0x33 The compiler s choice of which method to use when actually accessing the IO port is completely independent of the way the programmer chooses to write the code So even if the programmer uses the memory mapped paradigm and writes PORTA 0x40 the compiler can optimize this into the use of an sbi instruction of course provided the target address is within the allowable range for this instruction and the right hand side of the expression is a constant value known at compile time The advantage of using the memory mapped paradigm in C programs is that it makes the programs more portable to other C compilers for the AVR platform Some people might also feel that this is more readable For example the following two statements would be equivalent Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 18 Special function registers 75 outb DDRD inb DDRD amp LCDBITS DDRD amp LCDBITS The generated code is identical for both Whitout optimization the compiler strictly generates code following the memory mapped paradigm while with optimization turned on code is generated using the faster and smaller in out MCU instructions Note that special care must be taken when accessing some of the 16 bit timer IO reg isters where access from both the main program and within an interrupt context can happen See
139. hand side con sists of a CPP macro which will be substituted by its value 6 in this case before actually being passed to the assembler Note 4 The assembler uses integer operations in the host defined integer size 32 bits or longer when evaluating expressions This is in contrast to the C compiler that uses the C type int by default in order to calculate constant integer expressions In order to get a 100 kHz output we need to toggle the PD6 line 200000 times per second Since we use timer 0 without any prescaling options in order to get the desired frequency and accuracy we already run into serious timing consid erations while accepting and processing the timer overflow interrupt the timer already continues to count When pre loading the TCCNTO register we therefore have to account for the number of clock cycles required for interrupt acknowledge and for the instructions to reload TCCNTO 4 clock cycles for interrupt acknowl edge 2 cycles for the jump from the interrupt vector 2 cycles for the 2 instructions that reload TCCNTO This is what the constant fuzz is for Note 5 External functions need to be declared to be global main is the application en try point that will be jumped to from the ininitalization routine in crt s1200 0 Note 6 The main loop is just a single jump back to itself Square wave generation itself is completely handled by the timer 0 overflow interrupt service A sleep instruction using idle mode co
140. he string src Here character means byte these functions do not work with wide or multi byte characters Returns The strrchr function returns a pointer to the matched character or NULL if the character is not found 5 16 2 22 char x strrev char x string Reverse a string The strrev function reverses the order of the string Returns The strrev function returns a pointer to the beginning of the reversed string 5 16 2 23 char strsep char x string const char x delim Parse a string into tokens The strsep function locates in the string referenced by string the first occurrence of any character in the string delim or the terminating 0 character and replaces it with a 0 The location of the next character after the delimiter character or NULL if the end of the string was reached is stored in string An empty field i e one caused by two adjacent delimiter characters can be detected by comparing the location referenced by the pointer returned in string to 0 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 68 Returns The strtok_r function returns a pointer to the original value of xstring If xstringp is initially NULL strsep returns NULL 5 16 2 24 char x strstr const char s1 const char s2 Locate a substring The strstr function finds the first occurrence of the substring s2 in the string s1 The terminating 0
141. hen performing low level output work which is a very central point in microcon troller programming it is quite common that a particular bit needs to be set or cleared in some IO register While the device documentation provides mnemonic names for the various bits in the IO registers and the AVR device specific IO definitions reflect these names in definitions for numerical constants a way is needed to convert a bit number usually within a byte register into a byte value that can be assigned directly to the register However sometimes the direct bit numbers are needed as well e g in an sbi call so the definitions cannot usefully be made as byte values in the first place So in order to access a particular bit number as a byte value use the BV macro Of course the implementation of this macro is just the usual bit shift which is done by the compiler anyway thus doesn t impose any run time penalty so the following applies _BV 3 gt 1 lt lt 3 gt 0x08 However using the macro often makes the program better readable BV stands for bit value in case someone might ask you Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions Example clock timer 2 with full IO clock CS2x 0b001 toggle OC2 output on compare match COM2x 0b01 and clear timer on compare match CTC2 1 Make OC2 PD7 an output TCCR2 _BV COM20 _BV CTC2 _BV CS20 DDRD
142. iable since you may get incorrect results if you use an unsigned char or char due to truncation Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 63 Warning This function is not mint8 compatible although if you only care about testing for equality this function should be safe to use 5 16 2 4 void x memcpy void dest const void x src size_t len Copy a memory area The memcpy function copies len bytes from memory area src to memory area dest The memory areas may not overlap Use memmove if the memory areas do overlap Returns The memcpy function returns a pointer to dest 5 16 2 5 void x memmove void x dest const void x src size_t len Copy memory area The memmove function copies len bytes from memory area src to memory area dest The memory areas may overlap Returns The memmove function returns a pointer to dest 5 16 2 6 void x memset void x dest int val size_t len Fill memory with a constant byte The memset function fills the first len bytes of the memory area pointed to by dest with the constant byte val Returns The memset function returns a pointer to the memory area dest 5 16 2 7 int strcasecmp const char x s1 const char s2 Compare two strings ignoring case The strcasecmp function compares the two strings s1 and s2 ignoring the case of the characters Returns The strcasecmp function returns an integer less than equal to or great
143. ignals 5 17 Interrupts and Signals 5 17 1 Detailed Description Note This discussion of interrupts and signals was taken from Rich Neswold s docu ment See Acknowledgments It s nearly impossible to find compilers that agree on how to handle interrupt code Since the C language tries to stay away from machine dependent details each compiler writer is forced to design their method of support In the AVR GCC environment the vector table is predefined to point to interrupt rou tines with predetermined names By using the appropriate name your routine will be called when the corresponding interrupt occurs The device library provides a set of default interrupt routines which will get used if you don t define your own Patching into the vector table is only one part of the problem The compiler uses by convention a set of registers when it s normally executing compiler generated code It s important that these registers as well as the status register get saved and restored The extra code needed to do this is enabled by tagging the interrupt function with _ attribute__ interrupt These details seem to make interrupt routines a little messy but all these details are handled by the Interrupt API An interrupt routine is defined with one of two macros INTERRUPT and SIGNAL These macros register and mark the routine as an in terrupt handler for the specified peripheral The following is an example definition of
144. il Unused User definable fini0 Goes into an infinite loop after program termination and completion of any _exit code execution of code in the fini9 gt finil sections 7 7 8 Using Sections in Assembler Code Example include lt avr io h gt section init1 ax progbits ldi r0 Oxff out _SFR_IO_ADDR PORTB YU out _SFR_IO_ADDR DDRB ro Note The ax progbits tells the assembler that the section is allocatable a executable x and contains data Qprogbits For more detailed information on the section directive see the gas user manual 7 7 9 Using Sections in C Code Example include lt avr io h gt void my_init_portb void __attribute__ naked __attribute__ section initl1 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 8 Installing the GNU Tool Chain 126 void my_init_portb void outb PORTB Oxff outb DDRB Oxff 7 8 Installing the GNU Tool Chain Note This discussion was taken directly from Rich Neswold s document See Ac knowledgments Note This discussion is Unix specific FIXME troth 2002 08 13 we need a volunteer to add windows specific notes to these instructions This chapter shows how to build and install a complete development environment for the AVR processors using the GNU toolset The default behaviour for most of these tools is to install every thing under the usxr local directory In orde
145. inary conversion and up to 36 If radix is greater than 10 the next digit after 9 will be the letter a The ultoa function returns the pointer passed as s 5 15 4 28 char utoa unsigned int __val char __s int __radix Convert an unsigned integer to a string The function utoa converts the unsigned integer value from val into an ASCII repre sentation that will be stored under s The caller is responsible for providing sufficient storage in s Note The minimal size of the buffer s depends on the choice of radix For example if the radix is 2 binary you need to supply a buffer with a minimal length of 8 sizeof unsigned int 1 characters i e one character for each bit plus one for the string terminator Using a larger radix will require a smaller minimal buffer size Warning If the buffer is too small you risk a buffer overflow Conversion is done using the radix as base which may be a number between 2 binary conversion and up to 36 If radix is greater than 10 the next digit after 9 will be the letter a The utoa function returns the pointer passed as s 5 15 5 Variable Documentation 5 15 5 1 charr _malloc_heap_end malloc tunable Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 61 5 15 5 2 char _malloc_heap_start malloc tunable 5 15 5 3 size_t _malloc_margin malloc tunable 5 16 Strings 5 16 1 Detailed Description inclu
146. ing exter nal RAM is slower than internal RAM and errata of some AVR devices even prevent this configuration from working properly at all Back to FAQ Index 7 3 17 Which O flag to use There s a common misconception that larger numbers behind the O option might auto matically cause better optimization First there s no universal definition for better with optimization often being a speed vs code size tradeoff See the detailed discus sion for which option affects which part of the code generation A test case was run on an ATmega128 to judge the effect of compiling the library itself using different optimization levels The following table lists the results The test case consisted of around 2 KB of strings to sort Test 1 used qsort using the standard library stremp test 2 used a function that sorted the strings by their size thus had Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 99 two calls to strlen per invocation When comparing the resulting code size it should be noted that a floating point version of fvprintf was linked into the binary in order to print out the time elapsed which is entirely not affected by the different optimization levels and added about 2 5 KB to the code Optimization Size of text Time for test 1 Time for test 2 flags 03 6898 903 us 19 7 ms 02 6666 972 us 20 1 ms Os 6618 955 us 20 1 ms Os 6474 9
147. integer Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 107 constants to the range 0 to 7 for bit set and bit clear operations Mnemonic Constraints Mnemonic Constraints adc rr add rr adiw wl and rr andi d M asr T belr I bld rI brbc Llabel brbs Llabel bset I bst rI cbi LI cbr dl com r cp rr CDC rr cpi d M cpse rr dec T elpm tz eor rr in rI inc T ld re ldd r b ldi d M lds r label lpm LZ Is T lsr T mov rr movw rr mul rr neg T or rr ori d M out Lr pop T push T rol T ror T sbc rr sbci d M sbi LI sbic LI sbiw wl sbr d M sbrc rI sbrs rI ser d st e r std b r sts label r sub rr subi d M swap T Constraint characters may be prepended by a single constraint modifier Contraints without a modifier specify read only operands Modifiers are Modifier Specifies Write only operand usually used for all output operands Read write operand not supported by inline assembler amp Register should be used for output only Output operands must be write only and the C expression result must be an Ivalue which means that the operands must be valid on the left side of assignments Note that the compiler will not check if the operands are of reasonable type for the kind of operation used in the assembler instructions Generated on Wed Nov
148. invalid character in endptr If there were no digits at all however strtoul stores the original value of nptrinendptr Thus if xnptr is not 0 but endptr is 0 on return the entire string was valid The strtoul function return either the result of the conversion or if there was a lead ing minus sign the negation of the result of the conversion unless the original non negated value would overflow in the latter case strtoul returns ULONG_MAX and errno is set to ERANGE If no conversion could be performed 0 is returned 5 15 4 27 char ultoa unsigned long int __val char x _s int _radix Convert an unsigned long integer to a string The function ultoa converts the unsigned long integer value from val into an ASCII representation that will be stored under s The caller is responsible for providing suf Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 60 ficient storage in s Note The minimal size of the buffer s depends on the choice of radix For example if the radix is 2 binary you need to supply a buffer with a minimal length of 8 x sizeof unsigned long int 1 characters i e one character for each bit plus one for the string terminator Using a larger radix will require a smaller minimal buffer size Warning If the buffer is too small you risk a buffer overflow Conversion is done using the radix as base which may be a number between 2 b
149. jmp h gt setjmp saves the stack context environment in __jmpb for later use by longjmp The stack context will be invalidated if the function which called setjmp returns Parameters _jmpb Variable of type jmp_buf which holds the stack information such that the environment can be restored Returns setimp returns 0O if returning directly and non zero when returning from longjmp using the saved context 5 14 Standard IO facilities 5 14 1 Detailed Description include lt stdio h gt Warning This implementation of the standard IO facilities is new to avr libc It is not yet expected to remain stable so some aspects of the API might change in a future release This file declares the standard IO facilities that are implemented in avr libc Due to the nature of the underlying hardware only a limited subset of standard IO is im plemented There is no actual file implementation available so only device IO can be performed Since there s no operating system the application needs to provide enough details about their devices in order to make them usable by the standard IO facilities Due to space constraints some functionality has not been implemented at all like some of the printf conversions that have been left out Nevertheless potential users of this implementation should be warned the printf and scanf families of functions although usually associated with presumably simple things like the famous Hello world
150. l consume space in the target s SRAM In contrast global and static variables that have an initializer go into the data section of the file This will cause them to consume space in the object file in order to record the initializing value and in the flash ROM of the target device The latter is needed since the flash ROM is the only way that the compiler can tell the target device the value this variable is going to be initialized to Now if some programmer wants to make doubly sure their variables really get a 0 at program startup and adds an initializer just containing 0 on the right hand side they waste space While this waste of space applies to virtually any platform C is implemented on it s usually not noticeable on larger machines like PCs while the waste of flash ROM storage can be very painful on a small microcontroller like the AVR So in general variables should only be explicitly initialized if the initial value is non Zero Back to FAQ Index 7 3 9 Why do some 16 bit timer registers sometimes get trashed Some of the timer related 16 bit IO registers use a temporary register called TEMP in the Atmel datasheet to guarantee an atomic access to the register despite the fact that two separate 8 bit IO transfers are required to actually move the data Typically this includes access to the current timer counter value register TCNTn the input capture register ICRn and write access to the output compare regist
151. libc 3 Set the branch point tag setting lt major gt and lt minor gt accordingly evs tag avr libc lt major gt _ lt minor gt branchpoint 4 Create the branch cvs tag b avr lib lt major gt _ lt minor gt branch 5 Update the package version in configure in and commit configure in to cvs HEAD Change minor number to next odd value 6 Update the NEWS file and commit to cvs HEAD Add Changes since avr libc lt this_release gt 7 Check out a new tree for the branch CVR co r avr lib lt major gt _ lt minor gt branch Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 6 Release Numbering and Methodology 120 GO 10 11 12 Note CVS tags do not allow the use of periods Update the package version in configure in and commit configure in to cvs branch Change the patch number to 90 to denote that this now a branch leading up to a release Be sure to leave the lt date gt part of the version Bring the build system up to date by running reconf and doconf Perform a make distcheck and make sure it succeeds This will create the snapshot source tarball This should be considered the first release candidate Upload the snapshot tarball to savannah Announce the branch and the branch tag to the avr libc dev list so other devel opers can checkout the branch 7 6 2 2 Making a release A stable release will only be done on a branch not from the c
152. llows the Unix approach if a device such as a terminal needs special handling it is in the domain of the terminal device driver to provide this functionality Thus a simple function suitable as put for fdevopen that talks to a UART interface might look like this int Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities uart_putchar char c if c TMn uart_putchar r loop_until_bit_is_set UCSRA UDRE UDR c return 0 Note 3 This implementation has been chosen because the cost of maintaining an alias is considerably smaller than the cost of maintaining full copies of each stream Yet providing an implementation that offers the complete set of standard streams was deemed to be useful Not only that writing printf instead of fprintf mystream saves typing work but since avr gcc needs to resort to pass all arguments of variadic functions on the stack as opposed to pass ing them in registers for functions that take a fixed number of parameters the ability to pass one parameter less by implying st din will also save some execu tion time Defines define getchar fgetc stdin define FILE struct _file define stdin __iob 0 define stdout _iob 1 define stderr __iob 2 define EOF 1 define putc __c __stream fputc __c __stream define putchar __c fputc __c stdout define getc __stream fgetc __stream Functions int
153. lock TCCRIB _BV CS10 a8 81 e0 ldi r24 0x01 E aa 8e bd out Ox2e r24 46 set PWM value to 0 OCR 0 ac ib bc out Ox2b rl 43 ae la be out Ox2a rl 42 enable OCI and PB2 as output DDROC _BV OCI b0 88 e0 ldi r24 0x08 8 b2 87 bb out 0x17 r24 p 23 extern inline void timer_enable_int unsigned char ints ifdef TIMSK TIMSK ints b4 80 e8 Idi r24 0x80 r 128 b6 89 bf out 0x39 r24 fp Dab timer_enable_int _BV TOIE1 enable interrupts sei Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 150 b8 78 94 sei ba 08 95 ret 000000bc lt main gt ink main void be cf ed ldi r28 OxDF Fo i223 be d0 e0 ldi r29 0x00 0 60 de bf out Ox3e r29 gt 162 C23 cd bf out Ox3d r28 fr GA toinit L 15 c4 ef df rcall 34 Oxa4 loop forever the interrupts are doing the rest for Note 6 c6 fe OF rjmp wz Oxc6 000000c8 lt __bad_interrupt gt C8 9b cf rjmp 202 Ox0 7 11 5 Linker Map Files avr objdump is very useful but sometimes it s necessary to see information about the link that can only be generated by the linker A map file contains this information A map file is useful for monitoring the sizes of your code and data It also shows where modules are loaded and which modules were loaded from libraries It is yet another view of your application To get a map file I usually ad
154. m int ferror FILE x__stream int vfscanf FILE x_ stream const char _fmt va_list __ap int vfscanf_P FILE stream const char x_fmt va_list __ap int fscanf FILE x__stream const char x__fmt int fscanf_P FILE __stream const char __fmt int scanf const char __fmt int scanf P const char __fmt int sscanf const char x__buf const char __fmt int sscanf_P const char __buf const char __fmt FILE fdevopen int put char int get void int opts __attribute_ unused 5 14 2 Define Documentation 5 14 2 1 define EOF 1 EOF declares the value that is returned by various standard IO functions in case of an error Since the AVR platform currently doesn t contain an abstraction for actual files its origin as end of file is somewhat meaningless here 5 14 2 2 define FILE struct _ file FILE is the opaque structure that is passed around between the various standard IO functions Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 40 5 14 2 3 define getc __stream fgetc __stream The macro getc used to be a fast macro implementation with a functionality iden tical to fgetc For space constraints in avr libc it is just an alias for fgetc 5 14 2 4 int getchar void fgetc stdin The macro get char reads a character from stdin Return values and error handling is identical to fgetc 5 14 2 5
155. might be configured Refer to the datasheet for details If the external RAM is going to be used to store the variables from the C program i e the data and or bss segment in that memory area it is essential to set up the external memory interface early during the device initialization so the initialization of these variable will take place Refer to How to modify MCUCR or WDTCR early for a description how to do this using few lines of assembler code or to the chapter about memory sections for an example written in C The explanation of malloc contains a discussion about the use of internal RAM vs external RAM in particular with respect to the various possible locations of the heap area reserved for malloc It also explains the linker command line options that are required to move the memory regions away from their respective standard locations in internal RAM Finally if the application simply wants to use the additional RAM for private data storage kept outside the domain of the C compiler e g through a char variable initialized directly to a particular address it would be sufficient to defer the initializa tion of the external RAM interface to the beginning of main so no tweaking of the init1 section is necessary The same applies if only the heap is going to be located there since the application start up code does not affect the heap It is not recommended to locate the stack in external RAM In general access
156. n Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 9 Using the avrdude program 133 Note As of 2003 08 15 no offical AVaRice release works like this Use a 2 0 snapshot until the 2 1 release is made or use obtain the source from cvs 7 9 Using the avrdude program Note This section was contributed by Brian Dean bsd bsdhome com Note The avrdude program was previously called avrprog The name was changed to avoid confusion with the avrprog program that Atmel ships with AvrStudio avrdude is a program that is used to update or read the flash and EEPROM memories of Atmel AVR microcontrollers on FreeBSD Unix It supports the Atmel serial pro gramming protocol using the PC s parallel port and can upload either a raw binary file or an Intel Hex format file It can also be used in an interactive mode to individually update EEPROM cells fuse bits and or lock bits if their access is supported by the Atmel serial programming protocol The main flash instruction memory of the AVR can also be programmed in interactive mode however this is not very useful because one can only turn bits off The only way to turn flash bits on is to erase the entire memory using avrdude s e option avrdude is part of the FreeBSD ports system To install it simply do the following cd usr ports devel avrdude make install Once installed avrdude can program processors using the contents of the hex file specified on the command line I
157. n initialized and uninitialized variables sections data and bss the dynamic memory allocator and the stack that is used for calling subroutines and storing local automatic variables Also unlike larger architectures there is no hardware supported memory management which could help in separating the mentioned RAM regions from being overwritten by each other The standard RAM layout is to place data variables first from the beginning of the internal RAM followed by bss The stack is started from the top of internal RAM growing downwards The so called heap available for the dynamic memory allocator will be placed beyond the end of bss Thus there s no risk that dynamic memory will ever collide with the RAM variables unless there were bugs in the implementation of the allocator There is still a risk that the heap and stack could collide if there are large requirements for either dynamic memory or stack space The former can even happen if the allocations aren t all that large but dynamic memory allocations get fragmented over time such that new requests don t quite fit into the holes of previously freed regions Large stack space requirements can arise in a C function containing large and or numerous local variables or when recursively calling function Note The pictures shown in this document represent typical situations where the RAM locations refer to an ATmega128 The memory addresses used are not displayed in a li
158. n of setimp longjmp see Chapter 7 of Advanced Pro gramming in the UNIX Environment by W Richard Stevens Example include lt setjmp h gt Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 13 Setjmp and Longjmp 35 jmp_buf env int main void if setjmp env handle error main processing loop which calls foo some where void foo void blah blah blah if err longjmp env 1 Functions e int setjmp jmp_buf _jmpb e void longjmp jmp_buf __jmpb int __ret _ATTR_NORETURN__ 5 13 2 Function Documentation 5 13 2 1 void longjmp jmp_buf _jmpb int _ret Non local jump to a saved stack context include lt setjmp h gt longjmp restores the environment saved by the last call of setimp with the corre sponding _jmpb argument After longjmp is completed program execution contin ues as if the corresponding call of setjmp had just returned the value __ret Note longjmp cannot cause 0 to be returned If longjmp is invoked with a second argument of 0 1 will be returned instead Parameters _jmpb Information saved by a previous call to setjmp Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 36 _ret Value to return to the caller of setjmp Returns This function never returns 5 13 2 2 int setjmp jmp_buf _jmpb Save stack context for non local goto include lt set
159. n this example the file main hex is burned into the flash memory avrdude p 2313 e m flash i main hex avrdude AVR device initialized and ready to accept instructions avrdude Device signature 0xle9101 avrdude erasing chip avrdude done avrdude reading input file main hex avrdude input file main hex auto detected as Intel Hex avrdude writing flash 1749 0x00 avrdude 1750 bytes of flash written avrdude verifying flash memory against main hex avrdude reading on chip flash data Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 10 Using the GNU tools 134 1749 0x00 avrdude verifying avrdude 1750 bytes of flash verified avrdude done Thank you The p 2313 option lets avrdude know that we are operating on an AT90S2313 chip This option specifies the device id and is matched up with the device of the same id in avrdude s configuration file usr local etc avrdude conf To list valid parts specify the v option The e option instructs avrdude to perform a chip erase before programming this is almost always necessary before programming the flash The m flash option indicates that we want to upload data into the flash memory while i main hex specifies the name of the input file The EEPROM is uploaded in the same way the only difference is that you would use m eeprom instead of m flash To use interactive mode use the t option avrdude p 2313 t avrdude AV
160. name void __asm__ _ volatile__ reti include lt avr signal h gt Defines an empty interrupt handler function This will not generate any prolog or epilog code and will only return from the ISR Do not define a function body as this will define it for you Example EMPTY_INTERRUPT SIG_ADC Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 17 Interrupts and Signals 73 5 17 2 3 define INTERRUPT signame Value void signame void __attribute__ interrupt void signame void include lt avr signal h gt Introduces an interrupt handler function that runs with global interrupts initially en abled This allows interrupt handlers to be interrupted 5 17 2 4 define sei __asm__ __volatile__ sei include lt avr interrupt h gt Enables interrupts by clearing the global interrupt mask This function actually com piles into a single line of assembly so there is no function call overhead 5 17 2 5 define SIGNAL signame Value void signame void __attribute__ signal void signame void include lt avr signal h gt Introduces an interrupt handler function that runs with global interrupts initially dis abled 5 17 3 Function Documentation 5 17 3 1 void timer_enable_int unsigned char ints include lt avr interrupt h gt This function modifies the t imsk register The value you pass via ints is device specific Generated on Wed Nov 26 21
161. near scale Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 5 Using malloc 115 external RAM 0x1100 OxFFFF 2 on board RAM L j SP t RAMEND brkval lt SP __malloc_margin gt _ _malloc_heap_start __heap_start _ bss end _ data end __bss_start data start Figure 1 RAM map of a device with internal RAM Finally there s a challenge to make the memory allocator simple enough so the code size requirements will remain low yet powerful enough to avoid unnecessary memory fragmentation and to get it all done with reasonably few CPU cycles since microcon trollers aren t only often low on space but also run at much lower speeds than the typical PC these days The memory allocator implemented in avr libc tries to cope with all of these con straints and offers some tuning options that can be used if there are more resources available than in the default configuration 7 5 2 Internal vs external RAM Obviously the constraints are much harder to satisfy in the default configuration where only internal RAM is available Extreme care must be taken to avoid a stack heap collision both by making sure functions aren t nesting too deeply and don t require too much stack space for local variables as well as by being cautious with allocating too much dynamic memory If external RAM is available it is strongly recommended to move the heap into the external RA
162. not be very motivated to continue to develop it Keep those bug reports coming 7 2 avr libc and assembler programs 7 2 1 Introduction There might be several reasons to write code for AVR microcontrollers using plain assembler source code Among them are Code for devices that do not have RAM and are thus not supported by the C compiler Code for very time critical applications Special tweaks that cannot be done in C Usually all but the first could probably be done easily using the inline assembler facility of the compiler Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 2 avr libe and assembler programs 81 Although avr libc is primarily targeted to support programming AVR microcontrollers using the C and C language there s limited support for direct assembler usage as well The benefits of it are e Use of the C preprocessor and thus the ability to use the same symbolic constants that are available to C programs as well as a flexible macro concept that can use any valid C identifier as a macro whereas the assembler s macro concept is basically targeted to use a macro in place of an assembler instruction e Use of the runtime framework like automatically assigning interrupt vectors For devices that have RAM initializing the RAM variables can also be utilized 7 2 2 Invoking the compiler For the purpose described in this document the assembler and linker are usually not invoked man
163. ns If both x and y are zero the global variable errno is set to EDOM Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 12 Mathematics 32 5 12 3 5 double ceil double _x The ceil function returns the smallest integral value greater than or equal to x ex pressed as a floating point number 5 12 3 6 double cos double _x The cos function returns the cosine of x measured in radians 5 12 3 7 double cosh double __x The cosh function returns the hyperbolic cosine of x 5 12 3 8 double exp double _x The exp function returns the exponential value of x 5 12 3 9 double fabs double __x The fabs function computes the absolute value of a floating point number x 5 12 3 10 double floor double __x The floor function returns the largest integral value less than or equal to x expressed as a floating point number 5 12 3 11 double fmod double __x double __y The function fmod returns the floating point remainder of x y 5 12 3 12 double frexp double __value int x __exp The frexp function breaks a floating point number into a normalized fraction and an integral power of 2 It stores the integer in the int object pointed to by exp The frexp function returns the value x such that x is a double with magnitude in the interval 1 2 1 or zero and value equals x times 2 raised to the power xexp If value is zero both parts of the result are zero 5 12 3 13 double in
164. nst char x _ATTR_PURE_ char x strtok_r char x const char x char xx _ATTR_PURE_ char strupr char 5 16 2 Function Documentation 5 16 2 1 void x memccpy void x dest const void x src int val size_t len Copy memory area The memccpy function copies no more than len bytes from memory area src to mem ory area dest stopping when the character val is found Returns The memccpy function returns a pointer to the next character in dest after val or NULL if val was not found in the first len characters of src 5 16 2 2 void x memchr const void x src int val size_t len Scan memory for a character The memchr function scans the first len bytes of the memory area pointed to by src for the character val The first byte to match val interpreted as an unsigned character stops the operation Returns The memchr function returns a pointer to the matching byte or NULL if the character does not occur in the given memory area 5 16 2 3 int memcmp const void x s1 const void x s2 size_t len Compare memory areas The memcmp function compares the first len bytes of the memory areas sl and s2 The comparision is performed using unsigned char operations Returns The memcmp function returns an integer less than equal to or greater than zero if the first len bytes of sl is found respectively to be less than to match or be greater than the first len bytes of s2 Note Be sure to store the result in a 16 bit var
165. nt vsprintf char x __s const char _ fmt va_list ap Like sprintf but takes a variable argument list for the arguments 5 14 3 38 int vsprintf_P char gt __s const char __fmt va_list ap Variant of vsprintf that uses a fmt string that resides in program memory 5 15 General utilities 5 15 1 Detailed Description include lt stdlib h gt This file declares some basic C macros and functions as defined by the ISO standard plus some AVR specific extensions Data Structures e struct div_t e struct Idiv_t Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 15 General utilities 51 Non standard i e non ISO C functions define RANDOM_MAX 0x7FFFFFFF char x itoa int __val char __s int __radix char x Itoa long int __val char x__s int __radix char utoa unsigned int __val char __s int __radix char ultoa unsigned long int __val char __s int __radix long random void void srandom unsigned long _seed long random r unsigned long xctx Conversion functions for double arguments Note that these functions are not located in the default library Lilbc a but in the mathematical library 1ibm a So when linking the application the 1m option needs to be specified define DTOSTR_ALWAYS_SIGN 0x01 define DTOSTR_PLUS_SIGN 0x02 define DTOSTR UPPERCASE 0x04 char x dtostre double __val char x__s unsigned char __prec unsigned char _ flags char dtostrf d
166. nteger less than equal to or greater than zero if sl or the first n bytes thereof is found respectively to be less than to match or be greater than s2 5 5 3 12 char x strnepy_P char dest PGM P src size_t n The strncpy_P function is similar to strcpy_P except that not more than n bytes of src are copied Thus if there is no null byte among the first n bytes of src the result will not be null terminated In the case where the length of src is less than that of n the remainder of dest will be padded with nulls Returns The strncpy_P function returns a pointer to the destination string dest 5 6 Additional notes from lt avr sfr_defs h gt The lt avr sfr_defs h gt file is included by all of the lt avr ioXXXX h gt files which use macros defined here to make the special function register definitions look like C variables or simple constants depending on the _SFR_ASM_COMPAT define Some examples from lt avr iom128 h gt to show how to define such macros Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 6 Additional notes from lt avr sfr_defs h gt define PORTA _SFR_IO8 0x1b define TCNT1 _SFR_IO16 0x2c define PORTE _SFR_MEM8 0x61 define TCNT3 _SFR_MEM16 0x88 If _SFR_ASM_COMPAT is not defined C programs can use names like PORTA directly in C expressions also on the left side of assignment operators and GCC will do the right thing use short I O instructions if possible Th
167. nter nal RAM through the symbol __stack that is provided by the run time startup code This is probably a good idea anyway since internal RAM access is faster and even required for some early devices that had hardware bugs preventing them from using a stack in external RAM Note also that the heap for malloc will still be placed after all the variables in the data section so in this situation no stack heap collision can occur 7 11 A simple project At this point you should have the GNU tools configured built and installed on your system In this chapter we present a simple example of using the GNU tools in an AVR project After reading this chapter you should have a better feel as to how the tools are used and how a Makefile can be configured Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 11 A simple project 7 11 1 The Project This project will use the pulse width modulator PWM to ramp an LED on and off every two seconds An AT90S2313 processor will be used as the controller The circuit for this demonstration is shown in the schematic diagram If you have a development kit you should be able to use it rather than build the circuit for this project VCC AN SCK PB7 S 1O RESET MISO PB6 4 MOST PB5 XTAL2 PB4 18pf OCI PB3 H XTAL1 PBZ 20 yec AIN1 PB1 ean AINO PBO aH oa ICP EDS GND T1 PD5 TO PD4 sei INT1 PD3 INTO PD2 TXD PD1 RXD PDO
168. o contact the author via e mail For the latest release check http www ethernut de Herne 17th of May 2002 Harald Kipp harald kipp at egnite de Note As of 26th of July 2002 this document has been merged into the documentation for avr libc The latest version is now available at http savannah nongnu org projects avr libc 7 4 1 GCC asm Statement Let s start with a simple example of reading a value from port D asm in 0 1 r value I PORTD Each asm statement is devided by colons into four parts 1 The assembler instructions defined as a single string constant n o in 0 1 2 A list of output operands separated by commas Our example uses just one p value 3 A comma separated list of input operands Again our example uses one operand only I PORTD Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 104 4 Clobbered registers left empty in our example You can write assembler instructions in much the same way as you would write assem bler programs However registers and constants are used in a different way if they refer to expressions of your C program The connection between registers and C operands is specified in the second and third part of the asm instruction the list of input and output operands respectively The general form is asm code output operand list input operand list clobber list In the code section operands ar
169. oce aa sone eee ee ERR 21 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen CONTENTS ii 5 8 S9 5 12 5 14 5 7 2 Define Documentation e e e e es te sere besaai 21 5 743 Function Documentation s se a sa ea 6264428445 22 Watchdog timer handling lt lt o o os eo he ee ER RES 22 5 8 1 Detailed Description 00 0 22 5 8 2 Define Documentation soose eas sce k onbor a R 23 Character Operations Mare 24 5 9 1 Detailed Description gt gt se s cesi resse ctus 24 5 9 2 Function Documentation 0 0 25 System Errors e00 pe e osp o ee ee ee i 27 5 10 1 Detailed Description lt lt lt e sc osoosu 28 eb brewed 27 5 10 2 Define Documentation c sese nereg ee ee ee 21 Integer Ypes eee 28 SILI Detailed Description lt soe 24 a aos eden e R 28 5 11 2 Typedef Documentation ss o o sw erap erep eee 29 Mathematics ats be ew baw hE a ee E T AR I 30 12 1 Detailed Deseription lt lt cos sace 4 bho eee Ces 30 53122 Deime Documentation lt oe cs sespe apa eR K 31 5 12 3 Function Documentation oaoa oa 31 Semp and LnSm e cos ee oa R RR R E E E S 34 313 1 Detaled Descripnion lt lt 64 cee eee eee eRe 34 5 13 2 Function Documentation 0 0 35 Standard TO facilities se op c K kopai e a e RR o 36 5 14 1 Detailed Description gt s cce ec s cscs eener estia 36 514 2 Define Documentation 2 3244 cese ve ee ae 39 5 14 3 Function Documentation oaoa a 41
170. oop iteration TWEA is de asserted so the client will get informed that no further transfer is desired Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 13 Todo List 167 Note 12 Except in the case of lost arbitration all bus transactions must properly be termi nated by the master initiating a stop condition Note 13 Writing to the EEPROM device is simpler than reading since only a master trans mitter mode transfer is needed Note that the first packet after the SLA W se lection is always considered to be the EEPROM address for the next operation This packet is exactly the same as the one above sent before starting to read the device In case a master transmitter mode transfer is going to send more than one data packet all following packets will be considered data bytes to write at the in dicated address The internal address pointer will be incremented after each write operation Note 14 24Cxx devices can become write protected by strapping their 172WC pin to logic high Leaving it unconnected is explicitly allowed and constitutes logic low level i e no write protection In case of a write protected device all data transfer attempts will be NACKed by the device Note that some devices might not imple ment this 7 13 Todo List Group avr_boot From email with Marek On smaller devices all except AT mega64 128 _SPM_REG is in the I O space accessible with the shorter in and out in
171. operation fails If the value of the argument c character equals EOF the operation will fail and the stream will remain unchanged 5 14 3 31 int vfprintf FILE x __stream const char gt _fmt va_list _ap vfprintf is the central facility of the print f family of functions It outputs values to stream under control of a format string passed in fmt The actual values to print are passed as a variable argument list ap vfprintf returns the number of characters written to stream or EOF in case of an error Currently this will only happen if st ream has not been opened with write intent The format string is composed of zero or more directives ordinary characters not which are copied unchanged to the output stream and conversion specifications each of which results in fetching zero or more subsequent arguments Each conversion specification is introduced by the character The arguments must properly correspond after type promotion with the conversion specifier After the the following appear in sequence e Zero or more of the following flags The value should be converted to an alternate form For c d i s and u conversions this option has no effect For 0 conversions the precision of the number is increased to force the first character of the output string to a zero except if a zero value is printed with an explicit precision of zero For x and X conversions a non zero result has the string Ox or OX
172. ouble __val char __width char __prec char x__s Defines define RAND M AX 0x7FFF Typedefs typedef int __compar_fn_t const void const void Functions _inline__ void abort void _ATTR_NORETURN__ int abs int _1 _ATTR_CONST__ long labs long _i _ATTR CONST__ void x bsearch const void Kev const void __base size_t _nmemb size_t __size int __compar const void const void div_t div int _num int _denom _ asm__ __divmodhi4 _ ATTR CONST__ e Idivt Idiv long _num long _denom _asm_ _divmodsi4 _ATTR CONST_ Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen General utilities 52 void qsort void __base size_t _nmemb size_t _size _compar_fn_t compar long strtol const char x__nptr char __endptr int __base unsigned long strtoul const char __nptr char __endptr int __base _inline__ long atol const char _nptr _ATTR_PURE__ inline__ int atoi const char _nptr _ATTR_PURE__ void exit int __status _ATTR NORETURN__ void x malloc size_t __size _ATTR_MALLOC_ void free void __ptr void x calloc size_t __nele size_t __size _ATTR MALLOC__ double strtod const char x__nptr char __endptr int rand void void srand unsigned int __seed int rand_r unsigned long ctx Variables size_t _malloc_margin char x _ malloc_heap_start char x _ malloc_heap_end 5 15 2 Define Documentation 5 15 2 1 define DTOSTR_ALWAYS_SIGN 0x01 Bit value
173. owe thanks to e The GCC Team which produced a very capable set of development tools for an amazing number of platforms and processors e Denis Chertykov denisc overta ru for making the AVR specific changes to the GNU tools Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 2 avr libc and assembler programs 80 Denis Chertykov and Marek Michalkiewicz marekm linux org pl for developing the standard libraries and startup code for AVR GCC Uros Platise for developing the AVR programmer tool uisp Joerg Wunsch joerg FreeBSD ORG for adding all the AVR development tools to the FreeBSD http www freebsd org ports tree and for pro viding the basics for the demo project Brian Dean bsd bsdhome com for developing avrdude an alternative to uisp and for contributing documentation which describes how to use it Avr dude was previously called avrprog Eric Weddington eric ecentral com for maintaining the WinAVR package and thus making the continued improvements to the Opensource AVR toolchain available to many users Rich Neswold for writing the original avr tools document which he graciously allowed to be merged into this document and his improvements to the demo project All the people who have submitted suggestions patches and bug reports See the AUTHORS files of the various tools And lastly all the users who use the software If nobody used the software we would probably
174. p uint8 _t _BV SPMIE define boot_is_spm_interrupt _SPM_REG amp uint8_t _BV SPMIE define boot rww_busy _SPM_REG amp uint8_t BV _COMMON_ASB define boot_spm_busy _SPM_REG amp uint8_t BV SPMEN define boot_spm_busy_wait do while boot_spm_busy define boot_page_fill address data _boot_page_fill normal address data define boot_page_erase address __boot_page_erase_normal address define boot_page_write address __boot_page _write_normal address define boot rww_enable boot rww_enable define boot_lock_bits_set lock_bits boot lock_bits_set lock_bits Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 1 Bootloader Support Utilities 5 1 2 Define Documentation 5 1 2 1 define boot_is_spm_interrupt SPM REG amp uint8_t _ BV SPMIE Check if the SPM interrupt is enabled 5 1 2 2 define boot_lock_bits_set lock_bits __boot_lock_bits_set lock_bits Set the bootloader lock bits 5 1 2 3 define boot_page_erase address __boot_page_erase_normal address Erase the flash page that contains address Note address is a byte address in flash not a word address 5 1 2 4 define boot_page_fill address data __boot_page_fill normal address data Fill the bootloader temporary page buffer for flash address with data word Note The address is a byte address The data is a word The AVR writes data to the buffer a word at a time but addresses the buffer per byte So
175. pen 40 pgm_read_word 15 feof 41 pgm_read_word_far 15 ferror 41 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 171 fgetc 41 abort 52 fgets 41 abs 52 FILE 39 atoi 52 fprintf 41 atol 53 fprintf_P 42 bsearch 53 fputc 42 calloc 53 fputs 42 div 53 fputs_P 42 DTOSTR_ALWAYS_SIGN 51 fread 42 DTOSTR_PLUS_SIGN 51 fscanf 42 DTOSTR_UPPERCASE 52 fscanf_P 42 dtostre 53 fwrite 42 dtostrf 54 getc 39 exit 54 getchar 39 free 54 gets 43 itoa 54 printf 43 labs 55 printf_P 43 Idiv 55 putc 39 Itoa 55 putchar 39 malloc 56 puts 43 qsort 56 puts_P 43 rand 56 scanf 43 RAND_MAX 52 scanf_P 43 rand_r 56 snprintf 43 random 57 snprintf_P 43 RANDOM MAX 52 sprintf 44 random_r 57 sprintf P 44 srand 57 sscanf 44 srandom 57 sscanf_P 44 strtod 57 stderr 39 strtol 58 stdin 40 strtoul 58 stdout 40 ultoa 59 ungetc 44 utoa 59 vfprintf 44 avr_string vfprintf_P 47 memccpy 61 vfscanf 47 memchr 61 vfscanf_P 49 memcmp 61 vsnprintf 49 memcpy 62 vsnprintf_P 49 memmove 62 vsprintf 49 memset 62 vsprintf_P 49 strcasecmp 63 avr_stdlib strcat 63 _compar_fn_t 52 strchr 63 _ malloc_heap_end 60 strcmp 63 _malloc_heap_start 60 strcpy 64 _ malloc_margin 60 stricat 64 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 172 strlcpy 64 avr_boot 7 strlen 64 boot_spm_busy strlwr 65 avr_boot 7 strncasecmp 65 boot_spm_busy
176. ple polled mode interface Applications that require interrupt controlled EEPROM access to ensure that no time will be wasted in spinloops will have to deploy their own implementation Note All of the read write functions first make sure the EEPROM is ready to be ac cessed Since this may cause long delays if a write operation is still pending time critical applications should first poll the EEPROM e g using eeprom_is_ready before attempting any actual I O Note This library will not work with the ATmega169 since this device has the EEPROM IO ports at different locations Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 3 EEPROM handling 11 avr libc declarations define eeprom_is_ready bit_is_clear EECR EEWE uint8_t eeprom_read_byte const uint8_t addr uint16_t eeprom_read_word const uint16_t xaddr void eeprom_read_block void buf const void xaddr size_t n void eeprom_write_byte uint8_t addr uint8_t val void eeprom_write_word uint16_t xaddr uint16_t val void eeprom_write_block const void buf void addr size_t n Backwards compatibility defines e define eeprom_rb addr eeprom_read_byte uint8_t x addr e define eeprom_rw addr eeprom_read_word uint16_t addr e define eeprom_wb addr val eeprom_write_byte uint8 t addr uint8_ t val IAR C compatibility defines e define _LEEPUT addr val eeprom_wb addr val e define _LEEGET var addr var
177. quest it will simply leave its bus interface drivers at high impedance and does not respond to a selection in any way at all The master selecting the device will see the high level at SDA after transfering the SLA R W packet as a NACK to its selection request Thus the select process is simply started over effectively causing a repeated start condition until the device will eventually respond This polling procedure is recommended in the 24Cxx datasheet in order to minimize the busy wait time when writing Note that in case a device is broken and never responds to a selection e g since it is no longer present at all this will cause an infinite loop Thus the maximal number of iterations made until the device is declared to be not responding at all and an error is returned will be limited to MAX_ITER Note 10 This is called master receiver mode the bus master still supplies the SCL clock but the device slave drives the SDA line with the appropriate data After 8 data bits the master responds with an ACK bit SDA driven low in order to request another data transfer from the slave or it can leave the SDA line high NACK indicating to the slave that it is going to stop the transfer now Assertion of ACK is handled by setting the TWEA bit in TWCR when starting the current transfer Note 11 The control word sent out in order to initiate the transfer of the next data packet is initially set up to assert the TWEA bit During the last l
178. quired but may be left empty If your assembler routine won t use any input or output operand two colons must still follow the assembler code string A good example is a simple statement to disable interrupts asm volatile cli Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 105 7 4 2 Assembler Code You can use the same assembler instruction mnemonics as you d use with any other AVR assembler And you can write as many assembler statements into one code string as you like and your flash memory is able to hold Note The available assembler directives vary from one assembler to another To make it more readable you should put each statement on a seperate line asm volatile nop n t nop n t nop n t nop n t 21 The linefeed and tab characters will make the assembler listing generated by the com piler more readable It may look a bit odd for the first time but that s the way the compiler creates it s own assembler code You may also make use of some special registers Symbol Register __SREG__ Status register at address 0x3F SPL N Stack pointer high byte at address 0x3E SPOT Stack pointer low byte at address 0x3D _ tmp reg__ Register r0 used for temporary storage _ Zero_reg__ Register rl always zero Register rO may be freely used by your assembler code and need not be restored at the end of your code It s a good idea to use _tmp_reg
179. r to keep the AVR tools separate from the base system it is usually better to install everything into usr local avr If the usr local avr directory does not exist you should create it before trying to install anything You will need root access to install there If you don t have root access to the system you can alternatively install in your home directory for exam ple in HOME local avr Where you install is a completely arbitrary decision but should be consistent for all the tools You specify the installation directory by using the prefix dir option with the configure script It is important to install all the AVR tools in the same directory or some of the tools will not work correctly To ensure consistency and simplify the discussion we will use PREF IX to refer to whatever directory you wish to install in You can set this as an environment variable if you wish as such using a Bourne like shell PREFIX HOME local avr export PREFIX Note Be sure that you have your PATH environment variable set to search the direc tory you install everything in before you start installing anything For example if you use prefix PREFIX you must have S PREFIX bin in your exported PATH As such Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 8 Installing the GNU Tool Chain 127 PATH PATH PREFIX bin export PATH Warning If you have CC set to anything other than avr gcc in
180. rams available in the net Hopefully this document will help to increase their number It s assumed that you are familiar with writing AVR assembler programs because this is not an AVR assembler programming tutorial It s not a C language tutorial either Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 103 Note that this document does not cover file written completely in assembler language refer to avr libc and assembler programs for this Copyright C 2001 2002 by egnite Software GmbH Permission is granted to copy and distribute verbatim copies of this manual provided that the copyright notice and this permission notice are preserved on all copies Permis sion is granted to copy and distribute modified versions of this manual provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one This document describes version 3 3 of the compiler There may be some parts which hadn t been completely understood by the author himself and not all samples had been tested so far Because the author is German and not familiar with the English language there are definitely some typos and syntax errors in the text As a programmer the author knows that a wrong documentation sometimes might be worse than none Any way he decided to offer his little knowledge to the public in the hope to get enough response to improve this document Feel free t
181. ress out of range 0 0x3f so this should be fairly safe If you do not define __SFR_OFF SET so it will be 0x20 by default all special register addresses are defined as memory addresses so SREG is 0x5f and if code size and speed are not important and you don t like the ugly if above you can always use Ids sts to access them But this will not work if _SFR_OFFSET 0x20 so use a different macro defined only if __SFR_OFF SET 0x20 for safety Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 7 Power Management and Sleep Modes 21 sts _SFR_ADDR SPMCR r24 In C programs all 3 combinations of _SFR_ASM_COMPAT and __SFR_OFFSET are supported the _SFR_ADDR SPMCR macro can be used to get the address of the SPMCR register 0x57 or 0x68 depending on device The old inp outp macros are still supported but not recommended to use in new code The order of outp arguments is confusing 5 7 Power Management and Sleep Modes 5 7 1 Detailed Description include lt avr sleep h gt Use of the SLEEP instruction can allow your application to reduce it s power com sumption considerably AVR devices can be put into different sleep modes by chang ing the SMn bits of the MCU Control Register MCUCR Refer to the datasheet for the details relating to the device you are using Sleep Modes Note Some of these modes are not available on all devices See the datasheet for
182. return 0 Note By convention the suffix P to the function name is used as an indication that this function is going to accept a program space string Note also the use of the PSTRQ macro Back to FAQ Index 7 3 21 Why does the compiler compile an 8 bit operation that uses bitwise oper ators into a 16 bit operation in assembly Bitwise operations in Standard C will automatically promote their operands to an int which is by default 16 bits in avr gcc To work around this use typecasts on the operands including literals to declare that the values are to be 8 bit operands This may be especially important when clearing a bit var amp mask wrong way The bitwise not operator will also promote the value in mask to an int To keep it an 8 bit value typecast before the not operator Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 102 var amp unsigned char mask Back to FAQ Index 7 3 22 How to detect RAM memory and variable overlap problems You can simply run avr nm on your output ELF file Run it with the n option and it will sort the symbols numerically by default they are sorted alphabetically Look for the symbol _end that s the first address in RAM that is not allocated by a variable avr gcc internally adds 0x800000 to all data bss variable addresses so please ignore this offset Then the run time initialization code initializ
183. rform various operations on characters include lt ctype h gt Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 9 Character Operations 25 Character classification routines These functions perform character classification They return true or false status de pending whether the character passed to the function falls into the function s classifi cation i e isdigit returns true if its argument is any value 0 though 9 inclusive int isalnum int _c _ATTR_CONST_ int isalpha int __c _ATTR_CONST__ int isascii int __c _ATTR_CONST__ int isblank int __c _ATTR_CONST_ int iscntrl int __c _ATTR_CONST__ int isdigit int __c _ATTR_CONST_ int isgraph int __c _ATTR_CONST__ int islower int __c _ATTR_CONST_ int isprint int __c _ATTR CONST__ int ispunct int __c _ATTR_CONST_ int isspace int __c _ATTR_CONST_ int isupper int __c _ATTR_CONST__ int isxdigit int _c _ATTR CONST__ Character convertion routines If c is not an unsigned char value or EOF the behaviour of these functions is undefined 5 9 2 int toascii int __c _ATTR_CONST_ int tolower int __c _ATTR_CONST__ int toupper int __c _ATTR CONST__ Function Documentation 5 9 2 1 int isalnum int _c Checks for an alphanumeric character It is equivalent to isalpha c isdigit c 5 9 2 2 int isalpha int _c Checks for an alphabetic character It is equivalent to isupper c islower c 5 9 2 3 int isa
184. ring the start condition and SLA R W packet takes about 10 s The longest write period is supposed to not exceed 10 ms Thus normal operation should not require more than 100 iterations to get the device to respond to a selection Fy define MAX_ITER 200 sE OP je 1B ie AE E Number of bytes that can be written ina row see comments for ee24xx_write_page below Some vendor s devices would accept 16 but 8 seems to be the lowest common denominator a E E E Note that the page size must be a power of two this simplifies the page boundary calculations below ay define PAGE_SIZE 8 Saved TWI status register for error messages only We need to save it in a variable since the datasheet only guarantees the TWSR register to have valid contents while the TWINT bit in TWCR is set a uint8_t twst Do all the startup time peripheral initializations UART for our debug test output and TWI clock void ioinit void UCSRB _BV TXEN tx enable UBRR SYSCLK 16 9600UL 1 9600 Bd initialize TWI clock 100 kHz clock TWPS 0 gt prescaler 1 if defined TWPS0 has prescaler megal28 amp newer TWSR 0 endif TWBR SYSCLK 100000UL 16 2 Note 4 Send character c down the UART Tx wait until tx holding register is empty Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 12 Example using the two wire interfa
185. rintf the next pointer must be a pointer to void e n Nothing is expected instead the number of characters consumed thus far from the input is stored through the next pointer which must be a pointer to int This is not a conversion although it can be suppressed with the x flag These functions return the number of input items assigned which can be fewer than provided for or even zero in the event of a matching failure Zero indicates that while there was input available no conversions were assigned typically this is due to an invalid input character such as an alphabetic character for a d conversion The value EOF is returned if an input failure occurs before any conversion such as an end of file occurs If an error or end of file occurs after conversion has begun the number of conversions which were successfully completed is returned By default all the conversions described above are available except the floating point conversions and the conversion These conversions will be available in the ex tended version provided by the library libscanf_f1t a Note that either of these conversions requires the availability of a buffer that needs to be obtained at run time using malloc If this buffer cannot be obtained the operation is aborted returning the value EOF To link a program against the extended version use the following compiler flags in the link stage W1 u vfscanf lscanf_flt im A third version is available
186. rminating 0 character to the array pointed to by dest The strings may not overlap and the destination string dest must be large enough to receive the copy Returns The strcpy function returns a pointer to the destination string dest Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 65 Note If the destination string of a strcpy is not large enough that is if the programmer was stupid lazy and failed to check the size before copying then anything might happen Overflowing fixed length strings is a favourite cracker technique 5 16 2 12 size_t stricat char x dst const char x src size_t siz Concatenate two strings Appends src to string dst of size siz unlike strncat siz is the full size of dst not space left At most siz 1 characters will be copied Always NULL terminates unless siz lt strlen dst Returns The strlcat function returns strlen src MIN siz strlen initial dst If retval gt siz truncation occurred 5 16 2 13 size_t strlepy char dst const char src size_t siz Copy a string Copy src to string dst of size siz At most siz 1 characters will be copied Always NULL terminates unless siz 0 Returns The strlcpy function returns strlen src If retval gt siz truncation occurred 5 16 2 14 size_t strlen const char src Calculate the length of a string The strlen function calculates the length of the string src not including the
187. rrno 27 EEPROM handling 10 eeprom_is_ready avr_eeprom 11 eeprom_rb avr_eeprom 11 eeprom_read_block avr_eeprom 11 eeprom_read_byte avr_eeprom 11 eeprom_read_word avr_eeprom 12 eeprom_rw avr_eeprom 11 eeprom_wb avr_eeprom 11 eeprom_write_block avr_eeprom 12 eeprom_write_byte avr_eeprom 12 eeprom_write_word avr_eeprom 12 EMPTY INTERRUPT avr_interrupts 72 EOF avr_stdio 39 ERANGE avr_errno 27 exit avr_stdlib 54 exp avr_math 31 fabs avr_math 31 FAQ 84 fclose avr_stdio 40 fdevopen avr_stdio 40 feof avr_stdio 41 ferror avr_stdio 41 fgetc avr_stdio 41 fgets avr_stdio 41 FILE avr_stdio 39 floor avr_math 31 fmod avr_math 31 fprintf avr_stdio 41 fprintf_P avr_stdio 42 fputc avr_stdio 42 fputs avr_stdio 42 fputs_P avr_stdio 42 fread avr_stdio 42 free avr_stdlib 54 frexp avr_math 32 fscanf Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen INDEX 174 avr_stdio 42 fscanf_P avr_stdio 42 fwrite avr_stdio 42 General utilities 50 getc avr_stdio 39 getchar avr_stdio 39 gets avr_stdio 43 inb avr_sfr 76 inp avr_sfr 76 installation 126 installation avarice 132 installation avr libc 130 installation avrdude 131 installation avrprog 131 installation binutils 128 installation gcc 129 Installation gdb 131 installation simulavr 132 installation uisp 131 int16_t avr_inttypes 28 int
188. rror Error constant value required PORTB is a precompiler definition included in the processor specific file included in avr io h As you may know the precompiler will not touch strings and PORTB instead of 0x18 gets passed to the assembler One way to avoid this problem is asm volatile sbi 0 0x07 I PORTB Note avr io h already provides a sbi macro definition which can be used in C programs Back to FAQ Index Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 91 7 3 11 Why does the PC randomly jump around when single stepping through my program in avr gdb When compiling a program with both optimization O and debug information g which is fortunately possible in avr gcc the code watched in the debugger is opti mized code While it is not guaranteed very often this code runs with the exact same optimizations as it would run without the g switch This can have unwanted side effects Since the compiler is free to reorder code ex ecution as long as the semantics do not change code is often rearranged in order to make it possible to use a single branch instruction for conditional operations Branch instructions can only cover a short range for the target PC 63 through 64 words from the current PC If a branch instruction cannot be used directly the compiler needs to work around it by combining a skip instruction together with a relative jump Y jmp
189. s that are only performed when optimizing unreachable code unused variables See also the appropriate FAQ entry for issues regarding debugging optimized code e Wa assembler options e W1 linker options Pass the listed options to the assembler or linker respectively g Generate debugging information that can be used by avr gdb e ffreestanding Assume a freestanding environment as per the C standard This turns off au tomatic builtin functions though they can still be reached by prepending _ builtin to the actual function name It also makes the compiler not com plain when main is declared with a void return type which makes some sense in a microcontroller environment where the application cannot meaning fully provide a return value to its environment in most cases main won t even return anyway However this also turns off all optimizations normally done by the compiler which assume that functions known by a certain name be have as described by the standard E g applying the function strlen to a literal string will normally cause the compiler to immediately replace that call by the actual length of the string while with f freestanding it will always call strlen at run time e funsigned char Make any unqualfied char type an unsigned char Without this option they default to a signed char Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 10 Using the GNU tools 139
190. scii int __c Checks whether c is a 7 bit unsigned char value that fits into the ASCII character set Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 9 Character Operations 26 5 9 2 4 int isblank int _c Checks for a blank character that is a space or a tab 5 9 2 5 int iscntrl int __c Checks for a control character 5 9 2 6 int isdigit int _c Checks for a digit 0 through 9 5 9 2 7 int isgraph int _c Checks for any printable character except space 5 9 2 8 int islower int _c Checks for a lower case character 5 9 2 9 int isprint int __c Checks for any printable character including space 5 9 2 10 int ispunct int _c Checks for any printable character which is not a space or an alphanumeric character 5 9 2 11 int isspace int _c Checks for white space characters For the avr libc library these are space form feed f newline n carriage return r horizontal tab t and vertical tab C v 5 9 2 12 int isupper int _c Checks for an uppercase letter 5 9 2 13 int isxdigit int _c Checks for a hexadecimal digits i e one of 0123456789abcdefABCDEF Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 10 System Errors errno 27 5 9 2 14 int toascii int _c Converts c to a 7 bit unsigned char value that fits into the ASCII character set by clearing the high order bits Warning Many people
191. sei _asm__ __volatile__ sei e define cli _asm__ __volatile__ cli Macros for writing interrupt handler functions e define SIGNAL signame e define INTERRUPT signame e define EMPTY _INTERRUPT signame Allowing specific system wide interrupts In addition to globally enabling interrupts each device s particular interrupt needs to be enabled separately if interrupts for this device are desired While some devices Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 17 Interrupts and Signals 72 maintain their interrupt enable bit inside the device s register set external and timer interrupts have system wide configuration registers Example Enable timer 1 overflow interrupts timer_enable_int _BV TOIE1 Do some work Disable all timer interrupts timer_enable_int 0 Note Be careful when you use these functions If you already have a different interrupt enabled you could inadvertantly disable it by enabling another intterupt e void timer_enable_int unsigned char ints 5 17 2 Define Documentation 5 17 2 1 define cli _asm__ __volatile__ cli include lt avr interrupt h gt Disables all interrupts by clearing the global interrupt mask This function actually compiles into a single line of assembly so there is no function call overhead 5 17 2 2 define EMPTY _INTERRUPT signame Value void signame void __attribute__ naked X void sig
192. some inline macros handling the watchdog timer present in many AVR devices In order to prevent the watchdog timer configura tion from being accidentally altered by a crashing application a special timed sequence is required in order to change it The macros within this header file handle the required sequence automatically before changing any value Interrupts will be disabled during the manipulation Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 8 Watchdog timer handling 23 Note Depending on the fuse configuration of the particular device further restrictions might apply in particular it might be disallowed to turn off the watchdog timer Defines 5 8 2 5 8 2 1 define wdt_disable _wdt_write 0 Disable the watchdog timer if possible This attempts to turn off the WD define wdt_reset _asm__ __volatile__ wdr define wdt_enable timeout _wdt_write timeout _BV WDE define wdt_disable _wdt_write 0 define WDTO_15MS 0 define WDTO_30MS 1 define WDTO_60MS 2 define WDTO_120MS 3 define WDTO_250MS 4 define WDTO_500MS 5 define WDTO_IS 6 define WDTO_2S 7 Define Documentation WDTCR register E bit in the 5 8 2 2 define wdt_enable timeout _wdt_write timeout BV WDE Enable the watchdog timer configuring it for expiry after t imeout which is a com bination of the WDPO through WDP2 to write into the WDTCR register See also the symbolic constants
193. ssic CPU core up to 8 KB of ROM avr3 Classic CPU core more than 8 KB of ROM avr4 Enhanced CPU core up to 8 KB of ROM avr5 Enhanced CPU core more than 8 KB of ROM By default code is generated for the avr2 architecture Note that when only using mmcu architecture but no mmcu MCU type in cluding the file lt avr io h gt cannot work since it cannot decide which de vice s definitions to select e mmcu MCU type The following MCU types are currently understood by avr gcc The table matches them against the corresponding avr gcc architecture name and shows the preprocessor symbol declared by the mmcu option Architecture MCU name Macro avrl at90s1200 _AVR_AT90S1200__ avrl attiny11 _AVR_ATtiny11__ avr attiny 12 _ AVR_ATtiny 12__ avrl attiny 15 _ AVR_ATtiny15__ avrl attiny28 _ AVR_ATtiny28__ avr2 at90s2313 _AVR_AT90S2313__ avr2 at90s2323 AVR_AT90S2323__ avr2 at90s2333 AVR_AT90S2333__ avr2 at90s2343 _AVR_AT90S2343__ avr2 attiny22 _ AVR_ATtiny22__ avr2 attiny26 _ AVR _ATtiny26__ avr2 at90s44 14 _ AVR_AT90S4414__ Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 10 Using the GNU tools 136 Architecture MCU name Macro avr2 at90s4433 _ AVR_AT90S4433__ avr2 at90s4434 _ AVR_AT90S4434__ avr2 at90s8515 _ AVR_AT90S85 15__ avr2 at90c8534 _AVR_AT90C8534__
194. st applications There is a wealth of information in this document which goes beyond simply describ ing the interfaces and routines provided by the library We hope that this document provides enough information to get a new AVR developer up to speed quickly using the freely available development tools binutils gcc avr libc and many others If you find yourself stuck on a problem which this document doesn t quite address you may wish to post a message to the avr gcc mailing list Most of the developers of the AVR binutils and gcc ports in addition to the devleopers of avr libc subscribe to the list so you will usually be able to get your problem resolved You can subscribe to the listathttp www avrl org mailman listinfo avr gcc list Before posting to the list you might want to try reading the Frequently Asked Ques tions chapter of this document Note This document is a work in progress As such it may contain in correct information If you find a mistake please send an email to avr libc dev nongnu org describing the mistake Also send us an email if you find that a specific topic is missing from the document Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 1 AVR Libc 1 0 1 Supported Devices The following is a list of AVR devices currently supported by the library AT90S Type Devices e at90s1200 1 at90s2313 at90s2323 at90s2333 at90s2343 at90s4414 at90s4433 at90s4434 at90s8515 at90c8534 at
195. structions since the boot loader has a limited size this could be an important optimization Group avr_inttypes There is a pending patch that may go into gcc to change the behaviour of the mint8 option The current 2003 09 17 situation for mint8 is sizeof int 1 sizeof long 2 and sizeof long long 8 Note the absence of a 4 byte 32 bit type The patch proposes to change sozeof long long to be 4 bytes 32 bits When and if the patch is included in gcc we will need to change avr libe accordingly 7 14 Deprecated List Global eeprom_rb addr Use eeprom_read_byte in new programs Global eeprom_rw addr Use eeprom_read_word in new programs Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 14 Deprecated List 168 Global eeprom_wb addr val Use eeprom_write_byte in new programs Global PRG_RDB addr Use pgm_read_byte in new programs Global cbi sfr bit include lt avr io h gt For backwards compatibility only This macro will eventually be removed Global sbi sfr bit include lt avr io h gt For backwards compatibility only This macro will eventually be removed Global inb sfr include lt avr io h gt For backwards compatibility only This macro will eventually be removed Global outb sfr val include lt avr io h gt Global inw sfr include lt avr io h gt For backwards compatibility only This macro will eventually be removed Global outw sfr val include l
196. t avr io h gt For backwards compatibility only This macro will eventually be removed Global outp val sfr For backwards compatibility only This macro will eventually be removed Global inp sfr For backwards compatibility only This macro will eventually be removed Global BV bit For backwards compatibility only This macro will eventually be removed Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen Index PATH 126 PREFIX 126 prefix 126 BV avr_sfr 75 _EEGET avr_eeprom 11 EEPUT avr_eeprom 11 _ compar_fn_t avr_stdlib 52 __malloc_heap_end avr_stdlib 60 _ malloc_heap_start avr_stdlib 60 __malloc_margin avr_stdlib 60 _crc16_update avr_crc 8 _crc_ccitt_update avr_crc 8 _crc_xmodem_update avr_crc 9 abort avr_stdlib 52 abs avr_stdlib 52 acos avr_math 30 Additional notes from lt avr sfr_ defs h gt 19 asin avr_math 30 atan avr_math 31 atan2 avr_math 31 atoi avr_stdlib 52 atol avr_stdlib 53 AVR device specific IO definitions 12 avr_boot boot_is_spm_interrupt 6 boot_lock_bits_set 6 boot_page_erase 6 boot_page_fill 6 boot _page_write 7 boot_rww_busy 7 boot_rww_enable 7 boot_spm_busy 7 boot_spm_busy_wait 7 boot_spm_interrupt disable 7 boot_spm_interrupt enable 7 BOOTLOADER_SECTION 7 avr_crc _crc16_update 8 _crc_ccitt_update 8 _crc_xmodem_ update 9 avr_eeprom EEGET 11 _ EEPUT 11 eeprom_is_ready 11 eeprom rb 11 e
197. t stable release The patch version number of a development series is always 0 until a new branch is cut at which point the patch number is changed to 90 to denote the branch is approaching a release and the date appended to the version to denote that it is still in development All versions in development in cvs will also always have the date appended as a fourth version number The format of the date will be YY YYMMDD Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 6 Release Numbering and Methodology 119 So the development version number will look like this 1 1 0 20030825 While a pre release version number on a branch destined to become either 1 2 or 2 0 will look like this 1 1 90 20030828 7 6 2 Releasing AVR Libc The information in this section is only relevant to AVR Libc developers and can be ignored by end users Note In what follows I assume you know how to use cvs and how to checkout multiple source trees in a single directory without having them clobber each other If you don t know how to do this you probably shouldn t be making releases or cutting branches 7 6 2 1 Creating acvsbranch The following steps should be taken to cut a branch in cvs 1 Check out a fresh source tree from cvs HEAD 2 Update the NEWS file with pending release number and commit to cvs HEAD Change Changes since avr libc lt last release gt lt this_relelase gt to Changes in avr
198. t use jmp ca1l1 instructions that can cover the entire address range but that require more flash ROM and execution time mrt1 Dump the internal compilation result called RTL into comments in the gener ated assembler code Used for debugging avr gcc msize Dump the address size and relative cost of each statement into comments in the generated assembler code Used for debugging avr gcc mdeb Generate lots of debugging information to stderr Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 10 Using the GNU tools 138 7 10 1 2 Selected general compiler options The following general gcc options might be of some interest to AVR users e On Optimization level n Increasing n is meant to optimize more an optimization level of 0 means no optimization at all which is the default if no O option is present The special option Os is meant to turn on all 02 optimizations that are not expected to increase code size Note that at 03 gcc attempts to inline all simple functions For the AVR target this will normally constitute a large pessimization due to the code increasement The only other optimization turned on with 03 is frename registers which could rather be enabled manually instead A simple O option is equivalent to 01 Note also that turning off all optimizations will prevent some warnings from be ing issued since the generation of those warnings depends on code analysis step
199. t2 In C programs weakly bound to initialize the stack init3 Unused User definable init4 Copies the data section from flash to SRAM Also sets up and zeros out the bss section In Unix like targets data is normally initialized by the OS directly from the executable file Since this is impossible in an MCU environment avr gcc instead takes care of appending the data variables after text in the flash ROM image init4 then defines the code weakly bound which takes care of copying the contents of data from the flash to SRAM init5 Unused User definable init6 Unused for C programs but used for constructors in C programs init7 Unused User definable init8 Unused User definable init9 Jumps into main 7 7 7 The finiN Sections These sections are used to define the exit code executed after return from main or a call to exit These all are subparts of the text section The finiN sections are executed in descending order from 9 to 0 finit9 Unused User definable This is effectively where _exit starts fini8 Unused User definable fini7 Unused User definable Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 7 Memory Sections 125 fini6 Unused for C programs but used for destructors in C programs fini5 Unused User definable fini4 Unused User definable fini3 Unused User definable fini2 Unused User definable fin
200. target device for the available sleep modes e define SLEEP MODE IDLE 0 e define SLEEP MODE_ADC BV SMO0 e define SLEEP MODE PWR DOWN BV SM1 e define SLEEP MODE PWR SAVE _BV SMO BV SM1 e define SLEEP_MODE_STANDBY BV SM1 BV SM2 e define SLEEP_MODE_EXT_STANDBY BV SMO _BV SM1 _BV SM2 Sleep Functions e void set_sleep_mode uint8_t mode e void sleep_mode void 5 7 2 Define Documentation 5 7 2 1 define SLEEP_MODE_ADC _BV SMD0 ADC Noise Reduction Mode Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 8 Watchdog timer handling 22 5 7 2 2 define SLEEP MODE EXT STANDBY _BV SMO0 BV SM1 BV SM2 Extended Standby Mode 5 7 2 3 define SLEEP_MODE_IDLE 0 Idle mode 5 7 2 4 define SLEEP_MODE_PWR_DOWN _BV SM1 Power Down Mode 5 7 2 5 define SLEEP_MODE_PWR_SAVE _BV SM0 BV SM1 Power Save Mode 5 7 2 6 define SLEEP_MODE_STANDBY _BV SM1 _BV SM2 Standby Mode 5 7 3 Function Documentation 5 7 3 1 void set_sleep_mode uint8_t mode Set the bits in the MCUCR to select a sleep mode 5 7 3 2 void sleep_mode void Put the device in sleep mode How the device is brought out of sleep mode depends on the specific mode selected with the set_sleep_mode function See the data sheet for your device for more details 5 8 Watchdog timer handling 5 8 1 Detailed Description include lt avr wdt h gt This header file declares the interface to
201. ted in the format d ddde177dd where there is one digit before the decimal point char acter and the number of digits after it is equal to the precision if the precision is missing it is taken as 6 if the precision is zero no decimal point character appears An E conversion uses the letter E rather than e to introduce the exponent The exponent always contains two digits if the value is zero the exponent is 00 e fF The double argument is rounded and converted to decimal notation in the format ddd ddd where the number of digits after the decimal point character is equal to the precision specification If the precision is missing it is taken as 6 if the precision is explicitly zero no decimal point character appears If a decimal point appears at least one digit appears before it Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 47 e gG The double argument is converted in style f or e or F or E for G conver sions The precision specifies the number of significant digits If the precision is missing 6 digits are given if the precision is zero it is treated as 1 Style e is used if the exponent from its conversion is less than 4 or greater than or equal to the precision Trailing zeros are removed from the fractional part of the result a decimal point appears only if it is followed by at least one digit In no case does a non existent or small field width ca
202. the same register for input and out put then the output value would have been destroyed on the first assembler instruction Fortunately this example uses the amp constraint modifier to instruct the compiler not to select any register for the output value which is used for any of the input operands Back to swapping Here is the code to swap high and low byte of a 16 bit value asm volatile mov tmp_reg__ A0 n t mov A0 BO nye mov B0 __tmp_reg__ n t r value 0 value First you will notice the usage of register _tmp_reg__ which we listed among other special registers in the Assembler Code section You can use this register without saving its contents Completely new are those letters A and B in A0 and B0 In fact they refer to two different 8 bit registers both containing a part of value Another example to swap bytes of a 32 bit value asm volatile mov __tmp_reg__ AO n t mov A0 DO n t mov D0 _ tmp_reg__ n t Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 4 Inline Asm 109 mov __tmp_reg__ BO n t mov BO CO Anite mov C0 _ tmp_reg__ n t r value 0 value If operands do not fit into a single register the compiler will automatically assign enough registers to hold the entire operand In the assembler code you use A0 to refer to the lowest byte of the first operand A1 to the lowest byte of the second operand and
203. tly Asked Questions 85 M Oo Q A a A 11 12 13 14 15 16 17 18 19 20 21 7 3 2 How to modify MCUCR or WDTCR early What is all this _BV stuff about Can I use C on the AVR Shouldn t I initialize all my variables Why do some 16 bit timer registers sometimes get trashed How do I use a define d constant in an asm statement Why does the PC randomly jump around when single stepping through my pro gram in avr gdb How do I trace an assembler file in avr gdb How do I pass an IO port as a parameter to a function What registers are used by the C compiler How do I put an array of strings completely in ROM How to use external RAM Which O flag to use How do I relocate code to a fixed address My UART is generating nonsense My ATmegal28 keeps crashing Port F is completely broken Why do all my foo bar strings eat up the SRAM Why does the compiler compile an 8 bit operation that uses bitwise operators into a 16 bit operation in assembly How to detect RAM memory and variable overlap problems My program doesn t recognize a variable updated within an interrupt rou tine When using the optimizer in a loop like the following one uint8_t flag while flag 0 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 86 the compiler will typically optimize the access to flag completely away sinc
204. truncation occurred 5 5 3 8 size_t strlen_P PGM_P src The strlen_P function is similar to strlen except that src is a pointer to a string in program space Returns The strlen function returns the number of characters in src 5 5 3 9 int strncasecmp_P const char x s1 PGM _P s2 size_t n Compare two strings ignoring case The strncasecmp_P function is similar to strcasecmp_P except it only compares the first n characters of s1 Parameters sl A pointer to a string in the devices SRAM s2 A pointer to a string in the devices Flash n The maximum number of bytes to compare Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 6 Additional notes from lt avr sfr_defs h gt 19 Returns The strcasecmp_P function returns an integer less than equal to or greater than zero if sl or the first n bytes thereof is found respectively to be less than to match or be greater than s2 5 5 3 10 char x strncat_P char x dest PGM_P src size_t len Concatenate two strings The strncat_P function is similar to strncat except that the src string must be located in program space flash Returns The strncat_P function returns a pointer to the resulting string dest 5 5 3 11 int strncmp_P const char s1 PGM_P s2 size_t n The strncmp_P function is similar to stremp_P except it only compares the first at most n characters of sl and s2 Returns The strncmp_P function returns an i
205. ually but rather using the C compiler frontend avr gcc that in turn will call the assembler and linker as required This approach has the following advantages e There is basically only one program to be called directly avr gcc regardless of the actual source language used e The invokation of the C preprocessor will be automatic and will include the appropriate options to locate required include files in the filesystem e The invokation of the linker will be automatic and will include the appropri ate options to locate additional libraries as well as the application start up code crt XXX and linker script Note that the invokation of the C preprocessor will be automatic when the filename provided for the assembler file ends in S the capital letter s This would even apply to operating systems that use case insensitive filesystems since the actual decision is made based on the case of the filename suffix given on the command line not based on the actual filename from the file system Alternatively the language can explicitly be specified using the x assembler with cpp option 7 2 3 Example program The following annotated example features a simple 100 kHz square wave generator using an AT90S1200 clocked with a 10 7 MHz crystal Pin PD6 will be used for the square wave output include lt avr io h gt Note 1 work 16 Note 2 Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 2 avr libc
206. uld be used as well but probably would not conserve much energy anyway since the interrupt service is executed quite frequently Note 7 Interrupt functions can get the usual names that are also available to C programs The linker will then put them into the appropriate interrupt vector slots Note Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 84 that they must be declared global in order to be acceptable for this purpose This will only work if lt avr io h gt has been included Note that the assembler or linker have no chance to check the correct spelling of an interrupt function so it should be double checked When analyzing the resulting object file using avr objdump or avr nm a name like _vector_N should appear with N being a small integer number Note 8 As explained in the section about special function registers the actual IO port address should be obtained using the macro _SFR_IO_ADDR The AT90S1200 does not have RAM thus the memory mapped approach to access the IO registers is not available It would be slower than using in out instructions anyway Since the operation to reload TCCNTO is time critical it is even performed before saving SREG Obviously this requires that the instructions involved would not change any of the flag bits in SREG Note 9 Interrupt routines must not clobber the global CPU state Thus it is usually neces sary to save at l
207. unc_correct amp PORTB 0x55 set_bits_macro PORTB Oxf0 return 0 The first function will generate object code which is not even close to what is intended The major problem arises when the function is called When the compiler sees this call it will actually pass the value of the PORTB register using an IN instruction instead of passing the address of PORTB e g memory mapped io addr of 0x38 io port 0x18 for the mega128 This is seen clearly when looking at the disassembly of the call set_bits_func_wrong PORTB Oxaa 10a 6a ea ldi r22 OxAA 170 10c 88 b3 in r24 0x18 24 10e Oe 94 65 00 call Oxca So the function once called only sees the value of the port register and knows nothing about which port it came from At this point whatever object code is generated for Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 3 Frequently Asked Questions 94 the function by the compiler is irrelevant The interested reader can examine the full disassembly to see that the function s body is completely fubar The second function shows how to pass by reference the memory mapped address of the io port to the function so that you can read and write to it in the function Here s the object code generated for the function call set_bits_func_correct amp PORTB 0x55 1124 65 e5 ldi r22 0x55 x 285 114 88 e3 ldi r24 0x38 s 56 116 90 e0 ldi r25 08200 0 118 Oe 94 7c 00 call Oxf8 You can cl
208. unctions Characters are read from st ream and processed in a way described by fmt Conver sion results will be assigned to the parameters passed via ap The format string fmt is scanned for conversion specifications Anything that doesn t comprise a conversion specification is taken as text that is matched literally against the input White space in the format string will match any white space in the data Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 48 including none all other characters match only itself Processing is aborted as soon as the data and format string no longer match or there is an error or end of file condition on stream Most conversions skip leading white space before starting the actual conversion Conversions are introduced with the character Possible options can follow the e a x indicating that the conversion should be performed but the conversion result is to be discarded no parameters will be processed from ap e the character h indicating that the argument is a pointer to short int rather than int e the character 1 indicating that the argument is a pointer to Long int rather than int for integer type conversions or a pointer to double for floating point conversions In addition a maximal field width may be specified as a nonzero positive decimal integer which will restrict the conversion to at most this many characters from the input
209. urns The strncmp function returns an integer less than equal to or greater than zero if sl or the first n bytes thereof is found respectively to be less than to match or be greater than s2 5 16 2 19 char x strncpy char dest const char x src size_t len Copy a string The strncpy function is similar to strcpy except that not more than n bytes of src are copied Thus if there is no null byte among the first n bytes of src the result will not be null terminated In the case where the length of src is less than that of n the remainder of dest will be padded with nulls Returns The strncpy function returns a pointer to the destination string dest Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 16 Strings 67 5 16 2 20 size_t strnlen const char x src size_t len Determine the length of a fixed size string The strnlen function returns the number of characters in the string pointed to by src not including the terminating 0 character but at most len In doing this strnlen looks only at the first len characters at src and never beyond src len Returns The strnlen function returns strlen src if that is less than len or len if there is no 0 character among the first len characters pointed to by src 5 16 2 21 char x strrchr const char x src int val Locate character in string The strrchr function returns a pointer to the last occurrence of the character val in t
210. use truncation of a numeric field if the result of a conversion is wider than the field width the field is expanded to contain the conversion result Since the full implementation of all the mentioned features becomes fairly large three different flavours of vfprintf can be selected using linker options The default vf printf implements all the mentioned functionality except floating point conversions A minimized version of vfprintf is available that only implements the very basic in teger and string conversion facilities but none of the additional options that can be specified using conversion flags these flags are parsed correctly from the format spec ification but then simply ignored This version can be requested using the following compiler options W1 u vfprintf lprintf_min If the full functionality including the floating point conversions is required the follow ing options should be used W1 u vfprintf lprintf_flt im Limitations e The specified width and precision can be at most 127 e For floating point conversions trailing digits will be lost if a number close to DBL_MAX is converted with a precision gt 0 5 14 3 32 int vfprintf_P FILE _sfream const char __fmt va_list __ap Variant of vfprintf that uses a fmt string that resides in program memory 5 14 3 33 int vfscanf FILE __stream const char x __fmt va_list __ap Formatted input This function is the heart of the scanf family of f
211. verse double The function inverse returns 1 x Note This function does not belong to the C standard definition Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 12 Mathematics 33 5 12 3 14 int isinf double _x The function isinf returns 1 if the argument x is either positive or negative infinity otherwise 0 5 12 3 15 int isnan double __x The function isnan returns 1 if the argument x represents a not a number NaN object otherwise 0 5 12 3 16 double Idexp double __x int __exp The Idexp function multiplies a floating point number by an integral power of 2 The Idexp function returns the value of x times 2 raised to the power exp If the resultant value would cause an overflow the global variable errno is set to ERANGE and the value NaN is returned 5 12 3 17 double log double _x The log function returns the natural logarithm of argument x If the argument is less than or equal 0 a domain error will occur 5 12 3 18 double log10 double _x The log function returns the logarithm of argument x to base 10 If the argument is less than or equal 0 a domain error will occur 5 12 3 19 double modf double _ value double _iptr The modf function breaks the argument value into integral and fractional parts each of which has the same sign as the argument It stores the integral part as a double in the object pointed to by iptr The modf function returns th
212. vs HEAD The following steps should be taken when making a release 1 10 Make sure the source tree you are working from is on the correct branch cvs update r avr lib lt major gt _ lt minor gt branch Update the package version in configure in and commit it to cvs Update the gnu tool chain version requirements in the README and commit to CVS Update the ChangeLog file to note the release and commit to cvs on the branch Add Released avr libc lt this_release gt Bring the build system up to date by running reconf and doconf Perform a make distcheck and make sure it succeeds This will create the source tarball Tag the release _ lt patch gt is not given if this is the first release on this branch evs tag avr lib lt major gt _ lt minor gt _ lt patch gt release Upload the tarball to savannah Generate the latest documentation and upload to savannah Announce the release Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 7 Memory Sections 121 The following hypothetical diagram should help clarify version and branch relation ships HEAD 1 0 Branch 1 2 Branch cvs tag avr libc 1_0 branchpoint set version to 1 1 0 lt date gt N cvs tag b avr libc 1_0 branch set version to 0 90 90 lt date gt U set version to 1 0 cvs tag avr libc 1_0 release set version to 1 0 0 lt date gt U l set version to 1 0 1
213. will be unhappy if you use this function This function will convert accented letters into random characters 5 9 2 15 int tolower int _c Converts the letter c to lower case if possible 5 9 2 16 int toupper int _c Converts the letter c to upper case if possible 5 10 System Errors errno 5 10 1 Detailed Description include lt errno h gt Some functions in the library set the global variable errno when an error occurs The file lt errno h gt provides symbolic names for various error codes Warning The errno global variable is not safe to use in a threaded or multi task system A race condition can occur if a task is interrupted between the call which sets error and when the task examines errno If another task changes errno during this time the result will be incorrect for the interrupted task Defines e define EDOM 33 e define ERANGE 34 5 10 2 Define Documentation 5 10 2 1 define EDOM 33 Domain error Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 11 Integer Types 28 5 10 2 2 define ERANGE 34 Range error 5 11 Integer Types 5 11 1 Detailed Description include lt inttypes h gt Use ulintN_t if you need exactly N bits Since these typedefs are mandated by the C99 standard they are preferred over rolling your own typedefs Note If avr gcc s mint 8 option is used no 32 bit types will be available Todo There is a pending patch that may go into gc
214. x __stream const char _fmt Variant of fprintf that uses a fmt string that resides in program memory 5 14 3 10 int fputc int _c FILE _ stream The function fputc sends the character c though given as type int to stream It returns the character or EOF in case an error occurred 5 14 3 11 int fputs const char __str FILE x __stream Write the string pointed to by str to stream st ream Returns 0 on success and EOF on error 5 14 3 12 int fputs_P const char _str FILE _stream Variant of fputs where st r resides in program memory Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 5 14 Standard IO facilities 43 5 14 3 13 size_t fread void gt _ptr size_t _size size_t _nmemb FILE _ stream Read nmemb objects size bytes each from stream to the buffer pointed to by ptr Returns the number of objects successfully read i e nmemb unless an input error occured or end of file was encountered feof and ferror must be used to distinguish between these two conditions 5 14 3 14 int fscanf FILE x _stream const char gt __fmt The function f scanf performs formatted input reading the input data from st ream See vfscanf for details 5 14 3 15 int fscanf_P FILE x __stream const char _ fmt Variant of fscanf using a fmt string in program memory 5 14 3 16 size_t fwrite const void x __ptr size_t _size size_t _nmemb FILE x _ stream Write
215. xygen 7 10 Using the GNU tools 137 mno interrupts Generates code that changes the stack pointer without disabling interrupts Nor mally the state of the status register SREG is saved in a temporary register in terrupts are disabled while changing the stack pointer and SREG is restored mcall prologues Use subroutines for function prologue epilogue For complex functions that use many registers that needs to be saved restored on function entry exit this saves some space at the cost of a slightly increased execution time minit stack nnnn Set the initial stack pointer to nnnn By default the stack pointer is initialized to the symbol __stack which is set to RAMEND by the run time initialization code mtiny stack Change only the low 8 bits of the stack pointer mno table jump Do not generate tablejump instructions By default jump tables can be used to optimize switch statements When turned off sequences of compare state ments are used instead Jump tables are usually faster to execute on average but in particular for switch statements where most of the jumps would go to the default label they might waste a bit of flash memory mshort calls Use rjmp rcall limited range on gt 8K devices On avr2 and avr4 archi tectures less than 8 KB or flash memory this is always the case On avr3 and avr5 architectures calls and jumps to targets outside the current function will by defaul
216. y This can either be done at run time by writing directly to this variable or it can be done automatically at link time by adjusting the value of the symbol _heap_end The following example shows a linker command to relocate the entire data and bss segments and the heap to location 0x1100 in external RAM The heap will extend up to address Oxffff avr gcc Wl Tdata 0x801100 defsym __heap_end 0x80ffff Note See explanation for offset 0x800000 See the chapter about using gcc for the W1 options S bs E 5 D S on board RAM z x external RAM H o 6 6 6 SP 1 _ malloc_heap_end __heap_end RAMEND RE _ malloc_heap_start __heap_start __bss_end __data_en __bss_start data start Figure 2 Internal RAM stack only external RAM variables and heap If dynamic memory should be placed in external RAM while keeping the variables in internal RAM something like the following could be used Note that for demonstration purposes the assignment of the various regions has not been made adjacent in this example so there are holes below and above the heap in external RAM that remain completely unaccessible by regular variables or dynamic memory allocations shown in light bisque color in the picture below Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 5 Using malloc 117 avr gcc Wl defsym __heap_start 0x802000 defsym __heap_end 0x803fff giga RAM LU 0x
217. your environment this will cause the configure script to fail It is best to not have CC set at all Note The versions for the packages listed below are known to work together If you mix and match different versions you may have problems 7 8 1 Required Tools e GNU Binutils 2 14 http sources redhat com binutils Installation GCC 3 3 1 httpes gee gnu org Installation AVR Libc 1 0 http savannah gnu org projects avr libc Installation Note 2003 08 15 The 1 0 branch was created today 7 8 2 Optional Tools You can develop programs for AVR devices without the following tools They may or may not be of use for you Note The following programs are in constant development and the stated versions may be less than current when you read this Check the given websites for the latest versions e uisp 20030618 http savannah gnu org projects uisp Installation Generated on Wed Nov 26 21 10 23 2003 for avr libc by Doxygen 7 8 Installing the GNU Tool Chain 128 avrdude 4 1 0 http savannah nongnu org projects avrdude Installation Usage Notes GDB 6 0 http sources redhat com gdb Installation Note 2003 08 15 gdb 6 0 should be released soon Simulavr 0 1 1 http savannah gnu org projects simulavr Installation AVaRice 2 0 http avarice sourceforge net Installation Note 2003 08 15 avarice 2 0 only exists in cvs there should be 2 1 release soon 7 8 3 GNU Binutils

avr-libc Reference Manual

Contents

Download Pdf Manuals

Related Search

Related Contents