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
  61                         #define BITBANG_PDIDATA_PORT     PORTD
  62                         #define BITBANG_PDIDATA_DDR      DDRD
  63                         #define BITBANG_PDIDATA_PIN      PIND
  64                         #define BITBANG_PDIDATA_MASK     (1 << 3)
  65
  66                         #define BITBANG_PDICLOCK_PORT    PORTD
  67                         #define BITBANG_PDICLOCK_DDR     DDRD
  68                         #define BITBANG_PDICLOCK_PIN     PIND
  69                         #define BITBANG_PDICLOCK_MASK    (1 << 5)
  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
  81
  82                 #else
  83                         #define BITBANG_PDIDATA_PORT     PORTB
  84                         #define BITBANG_PDIDATA_DDR      DDRB
  85                         #define BITBANG_PDIDATA_PIN      PINB
  86                         #define BITBANG_PDIDATA_MASK     (1 << 3)
  87
  88                         #define BITBANG_PDICLOCK_PORT    RESET_LINE_PORT
  89                         #define BITBANG_PDICLOCK_DDR     RESET_LINE_DDR
  90                         #define BITBANG_PDICLOCK_PIN     RESET_LINE_PIN
  91                         #define BITBANG_PDICLOCK_MASK    RESET_LINE_MASK
  92
  93                         #define BITBANG_TPIDATA_PORT     PORTB
  94                         #define BITBANG_TPIDATA_DDR      DDRB
  95                         #define BITBANG_TPIDATA_PIN      PINB
  96                         #define BITBANG_TPIDATA_MASK     (1 << 3)
  97
  98                         #define BITBANG_TPICLOCK_PORT    PORTB
  99                         #define BITBANG_TPICLOCK_DDR     DDRB
 100                         #define BITBANG_TPICLOCK_PIN     PINB
 101                         #define BITBANG_TPICLOCK_MASK    (1 << 1)
 102                 #endif
 103
 104                 /** Total number of bits in a single USART frame */
 105                 #define BITS_IN_USART_FRAME      12
 106
 107                 #define PDI_CMD_LDS              0x00
 108                 #define PDI_CMD_LD               0x20
 109                 #define PDI_CMD_STS              0x40
 110                 #define PDI_CMD_ST               0x60
 111                 #define PDI_CMD_LDCS             0x80
 112                 #define PDI_CMD_REPEAT           0xA0
 113                 #define PDI_CMD_STCS             0xC0
 114                 #define PDI_CMD_KEY              0xE0
 115
 116                 #define PDI_STATUS_REG           0
 117                 #define PDI_RESET_REG            1
 118                 #define PDI_CTRL_REG             2
 119
 120                 #define PDI_STATUS_NVM           (1 << 1)
 121                 #define PDI_RESET_KEY            0x59
 122
 123                 #define PDI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
 124
 125                 #define PDI_DATSIZE_1BYTE        0
 126                 #define PDI_DATSIZE_2BYTES       1
 127                 #define PDI_DATSIZE_3BYTES       2
 128                 #define PDI_DATSIZE_4BYTES       3
 129
 130                 #define PDI_POINTER_INDIRECT     0
 131                 #define PDI_POINTER_INDIRECT_PI  1
 132                 #define PDI_POINTER_DIRECT       2
 133
 134                 #define TPI_CMD_SLD              0x20
 135                 #define TPI_CMD_SST              0x60
 136                 #define TPI_CMD_SSTPR            0x68
 137                 #define TPI_CMD_SIN              0x10
 138                 #define TPI_CMD_SOUT             0x90
 139                 #define TPI_CMD_SLDCS            0x80
 140                 #define TPI_CMD_SSTCS            0xC0
 141                 #define TPI_CMD_SKEY             0xE0
 142
 143                 #define TPI_STATUS_REG           0x00
 144                 #define TPI_CTRL_REG             0x02
 145                 #define TPI_ID_REG               0x0F
 146
 147                 #define TPI_STATUS_NVM           (1 << 1)
 148
 149                 #define TPI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
 150
 151                 #define TPI_POINTER_INDIRECT     0
 152                 #define TPI_POINTER_INDIRECT_PI  (1 << 2)
 153
 154         /* Function Prototypes: */
 155                 void    XPROGTarget_EnableTargetPDI(void);
 156                 void    XPROGTarget_EnableTargetTPI(void);
 157                 void    XPROGTarget_DisableTargetPDI(void);
 158                 void    XPROGTarget_DisableTargetTPI(void);
 159                 void    XPROGTarget_SendByte(const uint8_t Byte);
 160                 uint8_t XPROGTarget_ReceiveByte(void);
 161                 void    XPROGTarget_SendBreak(void);
 162                 bool    XPROGTarget_WaitWhileNVMBusBusy(void);
 163
 164 #endif