Projects/AVRISP/Lib/XPROG/XPROGTarget.h

   1 /*
   2              LUFA Library
   3      Copyright (C) Dean Camera, 2009.
   4
   5   dean [at] fourwalledcubicle [dot] com
   6       www.fourwalledcubicle.com
   7 */
   8
   9 /*
  10   Copyright 2009  Dean Camera (dean [at] fourwalledcubicle [dot] com)
  11
  12   Permission to use, copy, modify, and distribute this software
  13   and its documentation for any purpose and without fee is hereby
  14   granted, provided that the above copyright notice appear in all
  15   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  *  Header file for PDITarget.c.
  34  */
  35
  36 #ifndef _PDI_TARGET_
  37 #define _PDI_TARGET_
  38
  39         /* Includes: */
  40                 #include <avr/io.h>
  41                 #include <avr/interrupt.h>
  42                 #include <stdbool.h>
  43
  44                 #include <LUFA/Common/Common.h>
  45
  46                 #include "../V2Protocol.h"
  47
  48         /* Preprocessor Checks: */
  49                 #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
  50                         #undef ENABLE_ISP_PROTOCOL
  51
  52                         #if !defined(ENABLE_XPROG_PROTOCOL)
  53                                 #define ENABLE_XPROG_PROTOCOL
  54                         #endif
  55                 #endif
  56
  57         /* Defines: */
  58                 #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
  59                         #define XPROG_VIA_HARDWARE_USART
  60                 #else
  61                         #define BITBANG_PDIDATA_PORT     PORTB
  62                         #define BITBANG_PDIDATA_DDR      DDRB
  63                         #define BITBANG_PDIDATA_PIN      PINB
  64                         #define BITBANG_PDIDATA_MASK     (1 << 3)
  65
  66                         #define BITBANG_PDICLOCK_PORT    RESET_LINE_PORT
  67                         #define BITBANG_PDICLOCK_DDR     RESET_LINE_DDR
  68                         #define BITBANG_PDICLOCK_PIN     RESET_LINE_PIN
  69                         #define BITBANG_PDICLOCK_MASK    RESET_LINE_MASK
  70
  71                         #define BITBANG_TPIDATA_PORT     PORTB
  72                         #define BITBANG_TPIDATA_DDR      DDRB
  73                         #define BITBANG_TPIDATA_PIN      PINB
  74                         #define BITBANG_TPIDATA_MASK     (1 << 3)
  75
  76                         #define BITBANG_TPICLOCK_PORT    PORTB
  77                         #define BITBANG_TPICLOCK_DDR     DDRB
  78                         #define BITBANG_TPICLOCK_PIN     PINB
  79                         #define BITBANG_TPICLOCK_MASK    (1 << 1)
  80                 #endif
  81
  82                 /** Total number of bits in a single USART frame */
  83                 #define BITS_IN_USART_FRAME      12
  84
  85                 #define PDI_CMD_LDS              0x00
  86                 #define PDI_CMD_LD               0x20
  87                 #define PDI_CMD_STS              0x40
  88                 #define PDI_CMD_ST               0x60
  89                 #define PDI_CMD_LDCS             0x80
  90                 #define PDI_CMD_REPEAT           0xA0
  91                 #define PDI_CMD_STCS             0xC0
  92                 #define PDI_CMD_KEY              0xE0
  93
  94                 #define PDI_STATUS_REG           0
  95                 #define PDI_RESET_REG            1
  96                 #define PDI_CTRL_REG             2
  97
  98                 #define PDI_STATUS_NVM           (1 << 1)
  99                 #define PDI_RESET_KEY            0x59
 100
 101                 #define PDI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
 102
 103                 #define PDI_DATSIZE_1BYTE        0
 104                 #define PDI_DATSIZE_2BYTES       1
 105                 #define PDI_DATSIZE_3BYTES       2
 106                 #define PDI_DATSIZE_4BYTES       3
 107
 108                 #define PDI_POINTER_INDIRECT     0
 109                 #define PDI_POINTER_INDIRECT_PI  1
 110                 #define PDI_POINTER_DIRECT       2
 111
 112                 #define TPI_CMD_SLD              0x20
 113                 #define TPI_CMD_SST              0x60
 114                 #define TPI_CMD_SSTPR            0x68
 115                 #define TPI_CMD_SIN              0x10
 116                 #define TPI_CMD_SOUT             0x90
 117                 #define TPI_CMD_SLDCS            0x80
 118                 #define TPI_CMD_SSTCS            0xC0
 119                 #define TPI_CMD_SKEY             0xE0
 120
 121                 #define TPI_STATUS_REG           0x00
 122                 #define TPI_CTRL_REG             0x02
 123                 #define TPI_ID_REG               0x0F
 124
 125                 #define TPI_STATUS_NVM           (1 << 1)
 126
 127                 #define TPI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
 128
 129                 #define TPI_POINTER_INDIRECT     0
 130                 #define TPI_POINTER_INDIRECT_PI  (1 << 2)
 131
 132         /* Function Prototypes: */
 133                 void    XPROGTarget_EnableTargetTPI(void);
 134                 void    XPROGTarget_EnableTargetPDI(void);
 135                 void    XPROGTarget_DisableTargetTPI(void);
 136                 void    XPROGTarget_DisableTargetPDI(void);
 137                 void    XPROGTarget_SendByte(const uint8_t Byte);
 138                 uint8_t XPROGTarget_ReceiveByte(void);
 139                 void    XPROGTarget_SendBreak(void);
 140                 bool    XPROGTarget_WaitWhileNVMBusBusy(void);
 141
 142 #endif