Projects/AVRISP-MKII/Lib/XPROG/XPROGTarget.c

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2010.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2010  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, distribute, and sell this
  13   software and its documentation for any purpose is hereby granted
  14   without fee, provided that the above copyright notice appear in
  15   all copies and that both that the copyright notice and this
  16   permission notice and warranty disclaimer appear in supporting
  17   documentation, and that the name of the author not be used in
  18   advertising or publicity pertaining to distribution of the
  19   software without specific, written prior permission.
  20
  21   The author disclaim all warranties with regard to this
  22   software, including all implied warranties of merchantability
  23   and fitness.  In no event shall the author be liable for any
  24   special, indirect or consequential damages or any damages
  25   whatsoever resulting from loss of use, data or profits, whether
  26   in an action of contract, negligence or other tortious action,
  27   arising out of or in connection with the use or performance of
  28   this software.
  29 */
  30
  31 /** \file
  32  *
  33  *  Target-related functions for the PDI Protocol decoder.
  34  */
  35
  36 #define  INCLUDE_FROM_XPROGTARGET_C
  37 #include "XPROGTarget.h"
  38
  39 #if defined(ENABLE_XPROG_PROTOCOL) || defined(__DOXYGEN__)
  40
  41 /** Flag to indicate if the USART is currently in Tx or Rx mode. */
  42 volatile bool               IsSending;
  43
  44 #if !defined(XPROG_VIA_HARDWARE_USART)
  45 /** Software USART raw frame bits for transmission/reception. */
  46 volatile uint16_t           SoftUSART_Data;
  47
  48 /** Bits remaining to be sent or received via the software USART - set as a GPIOR for speed. */
  49 #define SoftUSART_BitCount  GPIOR2
  50
  51
  52 /** ISR to manage the PDI software USART when bit-banged PDI USART mode is selected. */
  53 ISR(TIMER1_COMPA_vect, ISR_BLOCK)
  54 {
  55         /* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
  56         BITBANG_PDICLOCK_PIN = BITBANG_PDICLOCK_MASK;
  57
  58         /* If not sending or receiving, just exit */
  59         if (!(SoftUSART_BitCount))
  60           return;
  61
  62         /* Check to see if we are at a rising or falling edge of the clock */
  63         if (BITBANG_PDICLOCK_PORT & BITBANG_PDICLOCK_MASK)
  64         {
  65                 /* If at rising clock edge and we are in send mode, abort */
  66                 if (IsSending)
  67                   return;
  68
  69                 /* Wait for the start bit when receiving */
  70                 if ((SoftUSART_BitCount == BITS_IN_USART_FRAME) && (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK))
  71                   return;
  72
  73                 /* Shift in the bit one less than the frame size in position, so that the start bit will eventually
  74                  * be discarded leaving the data to be byte-aligned for quick access (subtract 9 as we are ORing to the MSB) */
  75                 if (BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK)
  76                   ((uint8_t*)&SoftUSART_Data)[1] |= (1 << (BITS_IN_USART_FRAME - 9));
  77
  78                 SoftUSART_Data >>= 1;
  79                 SoftUSART_BitCount--;
  80         }
  81         else
  82         {
  83                 /* If not sending or receiving, just exit */
  84                 if (!(SoftUSART_BitCount))
  85                   return;
  86
  87                 /* If at falling clock edge and we are in receive mode, abort */
  88                 if (!IsSending)
  89                   return;
  90
  91                 /* Set the data line to the next bit value */
  92                 if (((uint8_t*)&SoftUSART_Data)[0] & 0x01)
  93                   BITBANG_PDIDATA_PORT |=  BITBANG_PDIDATA_MASK;
  94                 else
  95                   BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;
  96
  97                 SoftUSART_Data >>= 1;
  98                 SoftUSART_BitCount--;
  99         }
 100 }
 101
 102 /** ISR to manage the TPI software USART when bit-banged TPI USART mode is selected. */
 103 ISR(TIMER1_CAPT_vect, ISR_BLOCK)
 104 {
 105         /* Toggle CLOCK pin in a single cycle (see AVR datasheet) */
 106         BITBANG_TPICLOCK_PIN = BITBANG_TPICLOCK_MASK;
 107
 108         /* If not sending or receiving, just exit */
 109         if (!(SoftUSART_BitCount))
 110           return;
 111
 112         /* Check to see if we are at a rising or falling edge of the clock */
 113         if (BITBANG_TPICLOCK_PORT & BITBANG_TPICLOCK_MASK)
 114         {
 115                 /* If at rising clock edge and we are in send mode, abort */
 116                 if (IsSending)
 117                   return;
 118
 119                 /* Wait for the start bit when receiving */
 120                 if ((SoftUSART_BitCount == BITS_IN_USART_FRAME) && (BITBANG_TPIDATA_PIN & BITBANG_TPIDATA_MASK))
 121                   return;
 122
 123                 /* Shift in the bit one less than the frame size in position, so that the start bit will eventually
 124                  * be discarded leaving the data to be byte-aligned for quick access (subtract 9 as we are ORing to the MSB) */
 125                 if (BITBANG_TPIDATA_PIN & BITBANG_TPIDATA_MASK)
 126                  ((uint8_t*)&SoftUSART_Data)[1] |= (1 << (BITS_IN_USART_FRAME - 9));
 127
 128                 SoftUSART_Data >>= 1;
 129                 SoftUSART_BitCount--;
 130         }
 131         else
 132         {
 133                 /* If at falling clock edge and we are in receive mode, abort */
 134                 if (!IsSending)
 135                   return;
 136
 137                 /* Set the data line to the next bit value */
 138                 if (((uint8_t*)&SoftUSART_Data)[0] & 0x01)
 139                   BITBANG_TPIDATA_PORT |=  BITBANG_TPIDATA_MASK;
 140                 else
 141                   BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;
 142
 143                 SoftUSART_Data >>= 1;
 144                 SoftUSART_BitCount--;
 145         }
 146 }
 147 #endif
 148
 149 /** Enables the target's PDI interface, holding the target in reset until PDI mode is exited. */
 150 void XPROGTarget_EnableTargetPDI(void)
 151 {
 152         IsSending = false;
 153
 154 #if defined(XPROG_VIA_HARDWARE_USART)
 155         /* Set Tx and XCK as outputs, Rx as input */
 156         DDRD |=  (1 << 5) | (1 << 3);
 157         DDRD &= ~(1 << 2);
 158
 159         /* Set DATA line high for at least 90ns to disable /RESET functionality */
 160         PORTD |= (1 << 3);
 161         _delay_us(1);
 162
 163         /* Set up the synchronous USART for XMEGA communications -
 164            8 data bits, even parity, 2 stop bits */
 165         UBRR1  = (F_CPU / 500000UL);
 166         UCSR1B = (1 << TXEN1);
 167         UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
 168 #else
 169         /* Set DATA and CLOCK lines to outputs */
 170         BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
 171         BITBANG_PDICLOCK_DDR |= BITBANG_PDICLOCK_MASK;
 172
 173         /* Set DATA line high for at least 90ns to disable /RESET functionality */
 174         BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
 175         _delay_us(1);
 176
 177         /* Fire timer compare channel A ISR to manage the software USART */
 178         OCR1A   = BITS_BETWEEN_USART_CLOCKS;
 179         OCR1B   = BITS_BETWEEN_USART_CLOCKS;
 180         TCCR1B  = (1 << WGM12) | (1 << CS10);
 181         TIMSK1  = (1 << OCIE1A);
 182 #endif
 183
 184         /* Send two BREAKs of 12 bits each to enable PDI interface (need at least 16 idle bits) */
 185         XPROGTarget_SendBreak();
 186         XPROGTarget_SendBreak();
 187 }
 188
 189 /** Enables the target's TPI interface, holding the target in reset until TPI mode is exited. */
 190 void XPROGTarget_EnableTargetTPI(void)
 191 {
 192         IsSending = false;
 193
 194         /* Set /RESET line low for at least 400ns to enable TPI functionality */
 195         AUX_LINE_DDR  |=  AUX_LINE_MASK;
 196         AUX_LINE_PORT &= ~AUX_LINE_MASK;
 197         _delay_us(1);
 198
 199 #if defined(XPROG_VIA_HARDWARE_USART)
 200         /* Set Tx and XCK as outputs, Rx as input */
 201         DDRD |=  (1 << 5) | (1 << 3);
 202         DDRD &= ~(1 << 2);
 203
 204         /* Set up the synchronous USART for TINY communications -
 205            8 data bits, even parity, 2 stop bits */
 206         UBRR1  = (F_CPU / 500000UL);
 207         UCSR1B = (1 << TXEN1);
 208         UCSR1C = (1 << UMSEL10) | (1 << UPM11) | (1 << USBS1) | (1 << UCSZ11) | (1 << UCSZ10) | (1 << UCPOL1);
 209 #else
 210         /* Set DATA and CLOCK lines to outputs */
 211         BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;
 212         BITBANG_TPICLOCK_DDR |= BITBANG_TPICLOCK_MASK;
 213
 214         /* Set DATA line high for idle state */
 215         BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
 216
 217         /* Fire timer capture channel ISR to manage the software USART */
 218         ICR1    = BITS_BETWEEN_USART_CLOCKS;
 219         TCCR1B  = (1 << WGM13) | (1 << WGM12) | (1 << CS10);
 220         TIMSK1  = (1 << ICIE1);
 221 #endif
 222
 223         /* Send two BREAKs of 12 bits each to enable TPI interface (need at least 16 idle bits) */
 224         XPROGTarget_SendBreak();
 225         XPROGTarget_SendBreak();
 226 }
 227
 228 /** Disables the target's PDI interface, exits programming mode and starts the target's application. */
 229 void XPROGTarget_DisableTargetPDI(void)
 230 {
 231         /* Switch to Rx mode to ensure that all pending transmissions are complete */
 232         XPROGTarget_SetRxMode();
 233
 234 #if defined(XPROG_VIA_HARDWARE_USART)
 235         /* Turn off receiver and transmitter of the USART, clear settings */
 236         UCSR1A  = ((1 << TXC1) | (1 << RXC1));
 237         UCSR1B  = 0;
 238         UCSR1C  = 0;
 239
 240         /* Make Reset input with pullup to take target out of /RESET, tristate all other pins */
 241         DDRD  &= ~((1 << 5) | (1 << 3));
 242         PORTD &= ~((1 << 3) | (1 << 2));
 243         PORTD |=   (1 << 5);
 244 #else
 245         /* Turn off software USART management timer */
 246         TCCR1B = 0;
 247
 248         /* Make Reset input with pullup to take target out of /RESET, tristate all other pins */
 249         BITBANG_PDIDATA_DDR   &= ~BITBANG_PDIDATA_MASK;
 250         BITBANG_PDICLOCK_DDR  &= ~BITBANG_PDICLOCK_MASK;
 251         BITBANG_PDICLOCK_PORT &= ~BITBANG_PDICLOCK_MASK;
 252         BITBANG_PDIDATA_PORT  |=  BITBANG_PDIDATA_MASK;
 253 #endif
 254 }
 255
 256 /** Disables the target's TPI interface, exits programming mode and starts the target's application. */
 257 void XPROGTarget_DisableTargetTPI(void)
 258 {
 259         /* Switch to Rx mode to ensure that all pending transmissions are complete */
 260         XPROGTarget_SetRxMode();
 261
 262 #if defined(XPROG_VIA_HARDWARE_USART)
 263         /* Turn off receiver and transmitter of the USART, clear settings */
 264         UCSR1A |= (1 << TXC1) | (1 << RXC1);
 265         UCSR1B  = 0;
 266         UCSR1C  = 0;
 267
 268         /* Set all USART lines as input, tristate */
 269         DDRD  &= ~((1 << 5) | (1 << 3));
 270         PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
 271 #else
 272         /* Turn off software USART management timer */
 273         TCCR1B = 0;
 274
 275         /* Set DATA and CLOCK lines to inputs */
 276         BITBANG_TPIDATA_DDR   &= ~BITBANG_TPIDATA_MASK;
 277         BITBANG_TPICLOCK_DDR  &= ~BITBANG_TPICLOCK_MASK;
 278
 279         /* Tristate DATA and CLOCK lines */
 280         BITBANG_TPIDATA_PORT  &= ~BITBANG_TPIDATA_MASK;
 281         BITBANG_TPICLOCK_PORT &= ~BITBANG_TPICLOCK_MASK;
 282 #endif
 283
 284         /* Tristate target /RESET line */
 285         AUX_LINE_DDR  &= ~AUX_LINE_MASK;
 286         AUX_LINE_PORT &= ~AUX_LINE_MASK;
 287 }
 288
 289 /** Sends a byte via the USART.
 290  *
 291  *  \param[in] Byte  Byte to send through the USART
 292  */
 293 void XPROGTarget_SendByte(const uint8_t Byte)
 294 {
 295         /* Switch to Tx mode if currently in Rx mode */
 296         if (!(IsSending))
 297           XPROGTarget_SetTxMode();
 298
 299 #if defined(XPROG_VIA_HARDWARE_USART)
 300         /* Wait until there is space in the hardware Tx buffer before writing */
 301         while (!(UCSR1A & (1 << UDRE1)));
 302         UCSR1A |= (1 << TXC1);
 303         UDR1    = Byte;
 304 #else
 305         /* Calculate the new USART frame data here while while we wait for a previous byte (if any) to finish sending */
 306         uint16_t NewUSARTData = ((1 << 11) | (1 << 10) | (0 << 9) | ((uint16_t)Byte << 1) | (0 << 0));
 307
 308         /* Compute Even parity - while a bit is still set, chop off lowest bit and toggle parity bit */
 309         uint8_t ParityData = Byte;
 310         while (ParityData)
 311         {
 312                 NewUSARTData ^= (1 << 9);
 313                 ParityData   &= (ParityData - 1);
 314         }
 315
 316         /* Wait until transmitter is idle before writing new data */
 317         while (SoftUSART_BitCount);
 318
 319         /* Data shifted out LSB first, START DATA PARITY STOP STOP */
 320         SoftUSART_Data     = NewUSARTData;
 321         SoftUSART_BitCount = BITS_IN_USART_FRAME;
 322 #endif
 323 }
 324
 325 /** Receives a byte via the software USART, blocking until data is received.
 326  *
 327  *  \return Received byte from the USART
 328  */
 329 uint8_t XPROGTarget_ReceiveByte(void)
 330 {
 331         /* Switch to Rx mode if currently in Tx mode */
 332         if (IsSending)
 333           XPROGTarget_SetRxMode();
 334
 335 #if defined(XPROG_VIA_HARDWARE_USART)
 336         /* Wait until a byte has been received before reading */
 337         while (!(UCSR1A & (1 << RXC1)) && TimeoutMSRemaining)
 338         {
 339                 /* Manage software timeout */
 340                 if (TIFR0 & (1 << OCF0A))
 341                 {
 342                         TIFR0 |= (1 << OCF0A);
 343                         TimeoutMSRemaining--;
 344                 }
 345         }
 346
 347         return UDR1;
 348 #else
 349         /* Wait until a byte has been received before reading */
 350         SoftUSART_BitCount = BITS_IN_USART_FRAME;
 351         while (SoftUSART_BitCount && TimeoutMSRemaining)
 352         {
 353                 /* Manage software timeout */
 354                 if (TIFR0 & (1 << OCF0A))
 355                 {
 356                         TIFR0 |= (1 << OCF0A);
 357                         TimeoutMSRemaining--;
 358                 }
 359         }
 360
 361         if (TimeoutMSRemaining)
 362           TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 363
 364         /* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
 365         return (uint8_t)SoftUSART_Data;
 366 #endif
 367 }
 368
 369 /** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
 370 void XPROGTarget_SendBreak(void)
 371 {
 372         /* Switch to Tx mode if currently in Rx mode */
 373         if (!(IsSending))
 374           XPROGTarget_SetTxMode();
 375
 376 #if defined(XPROG_VIA_HARDWARE_USART)
 377         /* Need to do nothing for a full frame to send a BREAK */
 378         for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
 379         {
 380                 /* Wait for a full cycle of the clock */
 381                 while (PIND & (1 << 5));
 382                 while (!(PIND & (1 << 5)));
 383         }
 384 #else
 385         while (SoftUSART_BitCount);
 386
 387         /* Need to do nothing for a full frame to send a BREAK */
 388         SoftUSART_Data     = 0x0FFF;
 389         SoftUSART_BitCount = BITS_IN_USART_FRAME;
 390 #endif
 391 }
 392
 393 static void XPROGTarget_SetTxMode(void)
 394 {
 395 #if defined(XPROG_VIA_HARDWARE_USART)
 396         /* Wait for a full cycle of the clock */
 397         while (PIND & (1 << 5));
 398         while (!(PIND & (1 << 5)));
 399
 400         PORTD  |=  (1 << 3);
 401         DDRD   |=  (1 << 3);
 402
 403         UCSR1B &= ~(1 << RXEN1);
 404         UCSR1B |=  (1 << TXEN1);
 405
 406         IsSending = true;
 407 #else
 408         while (SoftUSART_BitCount);
 409
 410         /* Wait for a full cycle of the clock */
 411         SoftUSART_Data     = 0x0001;
 412         SoftUSART_BitCount = 1;
 413         while (SoftUSART_BitCount);
 414
 415         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 416         {
 417                 BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
 418                 BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
 419         }
 420         else
 421         {
 422                 BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
 423                 BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;
 424         }
 425 #endif
 426
 427         IsSending = true;
 428 }
 429
 430 static void XPROGTarget_SetRxMode(void)
 431 {
 432 #if defined(XPROG_VIA_HARDWARE_USART)
 433         while (!(UCSR1A & (1 << TXC1)));
 434         UCSR1A |=  (1 << TXC1);
 435
 436         UCSR1B &= ~(1 << TXEN1);
 437         UCSR1B |=  (1 << RXEN1);
 438
 439         DDRD   &= ~(1 << 3);
 440         PORTD  &= ~(1 << 3);
 441 #else
 442         while (SoftUSART_BitCount);
 443
 444         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 445         {
 446                 BITBANG_PDIDATA_DDR  &= ~BITBANG_PDIDATA_MASK;
 447                 BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;
 448         }
 449         else
 450         {
 451                 BITBANG_TPIDATA_DDR  &= ~BITBANG_TPIDATA_MASK;
 452                 BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;
 453         }
 454
 455         /* Wait until DATA line has been pulled up to idle by the target */
 456         while (!(BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK) && TimeoutMSRemaining)
 457         {
 458                 /* Manage software timeout */
 459                 if (TIFR0 & (1 << OCF0A))
 460                 {
 461                         TIFR0 |= (1 << OCF0A);
 462                         TimeoutMSRemaining--;
 463                 }
 464         }
 465 #endif
 466
 467     if (TimeoutMSRemaining)
 468           TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 469
 470         IsSending = false;
 471 }
 472
 473 #endif