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 / XPROG_HARDWARE_SPEED);
 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 / XPROG_HARDWARE_SPEED);
 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         /* Tristate all pins */
 241         DDRD  &= ~((1 << 5) | (1 << 3));
 242         PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
 243 #else
 244         /* Turn off software USART management timer */
 245         TCCR1B = 0;
 246
 247         /* Set DATA and CLOCK lines to inputs */
 248         BITBANG_PDIDATA_DDR   &= ~BITBANG_PDIDATA_MASK;
 249         BITBANG_PDICLOCK_DDR  &= ~BITBANG_PDICLOCK_MASK;
 250
 251         /* Tristate DATA and CLOCK lines */
 252         BITBANG_PDIDATA_PORT  &= ~BITBANG_PDIDATA_MASK;
 253         BITBANG_PDICLOCK_PORT &= ~BITBANG_PDICLOCK_MASK;
 254 #endif
 255 }
 256
 257 /** Disables the target's TPI interface, exits programming mode and starts the target's application. */
 258 void XPROGTarget_DisableTargetTPI(void)
 259 {
 260         /* Switch to Rx mode to ensure that all pending transmissions are complete */
 261         XPROGTarget_SetRxMode();
 262
 263 #if defined(XPROG_VIA_HARDWARE_USART)
 264         /* Turn off receiver and transmitter of the USART, clear settings */
 265         UCSR1A |= (1 << TXC1) | (1 << RXC1);
 266         UCSR1B  = 0;
 267         UCSR1C  = 0;
 268
 269         /* Set all USART lines as input, tristate */
 270         DDRD  &= ~((1 << 5) | (1 << 3));
 271         PORTD &= ~((1 << 5) | (1 << 3) | (1 << 2));
 272 #else
 273         /* Turn off software USART management timer */
 274         TCCR1B = 0;
 275
 276         /* Set DATA and CLOCK lines to inputs */
 277         BITBANG_TPIDATA_DDR   &= ~BITBANG_TPIDATA_MASK;
 278         BITBANG_TPICLOCK_DDR  &= ~BITBANG_TPICLOCK_MASK;
 279
 280         /* Tristate DATA and CLOCK lines */
 281         BITBANG_TPIDATA_PORT  &= ~BITBANG_TPIDATA_MASK;
 282         BITBANG_TPICLOCK_PORT &= ~BITBANG_TPICLOCK_MASK;
 283 #endif
 284
 285         /* Tristate target /RESET line */
 286         AUX_LINE_DDR  &= ~AUX_LINE_MASK;
 287         AUX_LINE_PORT &= ~AUX_LINE_MASK;
 288 }
 289
 290 /** Sends a byte via the USART.
 291  *
 292  *  \param[in] Byte  Byte to send through the USART
 293  */
 294 void XPROGTarget_SendByte(const uint8_t Byte)
 295 {
 296         /* Switch to Tx mode if currently in Rx mode */
 297         if (!(IsSending))
 298           XPROGTarget_SetTxMode();
 299
 300 #if defined(XPROG_VIA_HARDWARE_USART)
 301         /* Wait until there is space in the hardware Tx buffer before writing */
 302         while (!(UCSR1A & (1 << UDRE1)));
 303         UCSR1A |= (1 << TXC1);
 304         UDR1    = Byte;
 305 #else
 306         /* Calculate the new USART frame data here while while we wait for a previous byte (if any) to finish sending */
 307         uint16_t NewUSARTData = ((1 << 11) | (1 << 10) | (0 << 9) | ((uint16_t)Byte << 1) | (0 << 0));
 308
 309         /* Compute Even parity - while a bit is still set, chop off lowest bit and toggle parity bit */
 310         uint8_t ParityData = Byte;
 311         while (ParityData)
 312         {
 313                 NewUSARTData ^= (1 << 9);
 314                 ParityData   &= (ParityData - 1);
 315         }
 316
 317         /* Wait until transmitter is idle before writing new data */
 318         while (SoftUSART_BitCount);
 319
 320         /* Data shifted out LSB first, START DATA PARITY STOP STOP */
 321         SoftUSART_Data     = NewUSARTData;
 322         SoftUSART_BitCount = BITS_IN_USART_FRAME;
 323 #endif
 324 }
 325
 326 /** Receives a byte via the software USART, blocking until data is received.
 327  *
 328  *  \return Received byte from the USART
 329  */
 330 uint8_t XPROGTarget_ReceiveByte(void)
 331 {
 332         /* Switch to Rx mode if currently in Tx mode */
 333         if (IsSending)
 334           XPROGTarget_SetRxMode();
 335
 336 #if defined(XPROG_VIA_HARDWARE_USART)
 337         /* Wait until a byte has been received before reading */
 338         while (!(UCSR1A & (1 << RXC1)) && TimeoutMSRemaining)
 339         {
 340                 /* Manage software timeout */
 341                 if (TIFR0 & (1 << OCF0A))
 342                 {
 343                         TIFR0 |= (1 << OCF0A);
 344                         TimeoutMSRemaining--;
 345                 }
 346         }
 347
 348         return UDR1;
 349 #else
 350         /* Wait until a byte has been received before reading */
 351         SoftUSART_BitCount = BITS_IN_USART_FRAME;
 352         while (SoftUSART_BitCount && TimeoutMSRemaining)
 353         {
 354                 /* Manage software timeout */
 355                 if (TIFR0 & (1 << OCF0A))
 356                 {
 357                         TIFR0 |= (1 << OCF0A);
 358                         TimeoutMSRemaining--;
 359                 }
 360         }
 361
 362         if (TimeoutMSRemaining)
 363           TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 364
 365         /* Throw away the parity and stop bits to leave only the data (start bit is already discarded) */
 366         return (uint8_t)SoftUSART_Data;
 367 #endif
 368 }
 369
 370 /** Sends a BREAK via the USART to the attached target, consisting of a full frame of idle bits. */
 371 void XPROGTarget_SendBreak(void)
 372 {
 373         /* Switch to Tx mode if currently in Rx mode */
 374         if (!(IsSending))
 375           XPROGTarget_SetTxMode();
 376
 377 #if defined(XPROG_VIA_HARDWARE_USART)
 378         /* Need to do nothing for a full frame to send a BREAK */
 379         for (uint8_t i = 0; i < BITS_IN_USART_FRAME; i++)
 380         {
 381                 /* Wait for a full cycle of the clock */
 382                 while (PIND & (1 << 5));
 383                 while (!(PIND & (1 << 5)));
 384         }
 385 #else
 386         while (SoftUSART_BitCount);
 387
 388         /* Need to do nothing for a full frame to send a BREAK */
 389         SoftUSART_Data     = 0x0FFF;
 390         SoftUSART_BitCount = BITS_IN_USART_FRAME;
 391 #endif
 392 }
 393
 394 static void XPROGTarget_SetTxMode(void)
 395 {
 396 #if defined(XPROG_VIA_HARDWARE_USART)
 397         /* Wait for a full cycle of the clock */
 398         while (PIND & (1 << 5));
 399         while (!(PIND & (1 << 5)));
 400
 401         PORTD  |=  (1 << 3);
 402         DDRD   |=  (1 << 3);
 403
 404         UCSR1B &= ~(1 << RXEN1);
 405         UCSR1B |=  (1 << TXEN1);
 406
 407         IsSending = true;
 408 #else
 409         while (SoftUSART_BitCount);
 410
 411         /* Wait for a full cycle of the clock */
 412         SoftUSART_Data     = 0x0001;
 413         SoftUSART_BitCount = 1;
 414         while (SoftUSART_BitCount);
 415
 416         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 417         {
 418                 BITBANG_PDIDATA_PORT |= BITBANG_PDIDATA_MASK;
 419                 BITBANG_PDIDATA_DDR  |= BITBANG_PDIDATA_MASK;
 420         }
 421         else
 422         {
 423                 BITBANG_TPIDATA_PORT |= BITBANG_TPIDATA_MASK;
 424                 BITBANG_TPIDATA_DDR  |= BITBANG_TPIDATA_MASK;
 425         }
 426 #endif
 427
 428         IsSending = true;
 429 }
 430
 431 static void XPROGTarget_SetRxMode(void)
 432 {
 433 #if defined(XPROG_VIA_HARDWARE_USART)
 434         while (!(UCSR1A & (1 << TXC1)));
 435         UCSR1A |=  (1 << TXC1);
 436
 437         UCSR1B &= ~(1 << TXEN1);
 438         UCSR1B |=  (1 << RXEN1);
 439
 440         DDRD   &= ~(1 << 3);
 441         PORTD  &= ~(1 << 3);
 442 #else
 443         while (SoftUSART_BitCount);
 444
 445         if (XPROG_SelectedProtocol == XPRG_PROTOCOL_PDI)
 446         {
 447                 BITBANG_PDIDATA_DDR  &= ~BITBANG_PDIDATA_MASK;
 448                 BITBANG_PDIDATA_PORT &= ~BITBANG_PDIDATA_MASK;
 449         }
 450         else
 451         {
 452                 BITBANG_TPIDATA_DDR  &= ~BITBANG_TPIDATA_MASK;
 453                 BITBANG_TPIDATA_PORT &= ~BITBANG_TPIDATA_MASK;
 454         }
 455
 456         /* Wait until DATA line has been pulled up to idle by the target */
 457         while (!(BITBANG_PDIDATA_PIN & BITBANG_PDIDATA_MASK) && TimeoutMSRemaining)
 458         {
 459                 /* Manage software timeout */
 460                 if (TIFR0 & (1 << OCF0A))
 461                 {
 462                         TIFR0 |= (1 << OCF0A);
 463                         TimeoutMSRemaining--;
 464                 }
 465         }
 466 #endif
 467
 468     if (TimeoutMSRemaining)
 469           TimeoutMSRemaining = COMMAND_TIMEOUT_MS;
 470
 471         IsSending = false;
 472 }
 473
 474 #endif