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

   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  *  Header file for XPROGTarget.c.
  34  */
  35
  36 #ifndef _XPROG_TARGET_
  37 #define _XPROG_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                 #include "XPROGProtocol.h"
  48
  49         /* Preprocessor Checks: */
  50                 #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
  51                         #undef ENABLE_ISP_PROTOCOL
  52
  53                         #if !defined(ENABLE_XPROG_PROTOCOL)
  54                                 #define ENABLE_XPROG_PROTOCOL
  55                         #endif
  56                 #endif
  57
  58         /* Defines: */
  59                 #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
  60                         #define XPROG_VIA_HARDWARE_USART
  61                 #else
  62                         #define BITBANG_PDIDATA_PORT     PORTB
  63                         #define BITBANG_PDIDATA_DDR      DDRB
  64                         #define BITBANG_PDIDATA_PIN      PINB
  65                         #define BITBANG_PDIDATA_MASK     (1 << 3)
  66
  67                         #define BITBANG_PDICLOCK_PORT    AUX_LINE_PORT
  68                         #define BITBANG_PDICLOCK_DDR     AUX_LINE_DDR
  69                         #define BITBANG_PDICLOCK_PIN     AUX_LINE_PIN
  70                         #define BITBANG_PDICLOCK_MASK    AUX_LINE_MASK
  71
  72                         #define BITBANG_TPIDATA_PORT     PORTB
  73                         #define BITBANG_TPIDATA_DDR      DDRB
  74                         #define BITBANG_TPIDATA_PIN      PINB
  75                         #define BITBANG_TPIDATA_MASK     (1 << 3)
  76
  77                         #define BITBANG_TPICLOCK_PORT    PORTB
  78                         #define BITBANG_TPICLOCK_DDR     DDRB
  79                         #define BITBANG_TPICLOCK_PIN     PINB
  80                         #define BITBANG_TPICLOCK_MASK    (1 << 1)
  81                 #endif
  82
  83                 /** Serial carrier TPI/PDI speed when hardware TPI/PDI mode is used */
  84                 #define XPROG_HARDWARE_SPEED       1000000
  85
  86                 /** Number of cycles between each clock when software USART mode is used */
  87                 #define BITS_BETWEEN_USART_CLOCKS  100
  88
  89                 /** Total number of bits in a single USART frame */
  90                 #define BITS_IN_USART_FRAME        12
  91
  92                 #define PDI_CMD_LDS                0x00
  93                 #define PDI_CMD_LD                 0x20
  94                 #define PDI_CMD_STS                0x40
  95                 #define PDI_CMD_ST                 0x60
  96                 #define PDI_CMD_LDCS               0x80
  97                 #define PDI_CMD_REPEAT             0xA0
  98                 #define PDI_CMD_STCS               0xC0
  99                 #define PDI_CMD_KEY                0xE0
 100
 101                 #define PDI_STATUS_REG             0
 102                 #define PDI_RESET_REG              1
 103                 #define PDI_CTRL_REG               2
 104
 105                 #define PDI_STATUS_NVM             (1 << 1)
 106
 107                 #define PDI_RESET_KEY              0x59
 108                 #define PDI_NVMENABLE_KEY          (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
 109
 110                 #define PDI_DATSIZE_1BYTE          0
 111                 #define PDI_DATSIZE_2BYTES         1
 112                 #define PDI_DATSIZE_3BYTES         2
 113                 #define PDI_DATSIZE_4BYTES         3
 114
 115                 #define PDI_POINTER_INDIRECT       0
 116                 #define PDI_POINTER_INDIRECT_PI    1
 117                 #define PDI_POINTER_DIRECT         2
 118
 119                 #define TPI_CMD_SLD                0x20
 120                 #define TPI_CMD_SST                0x60
 121                 #define TPI_CMD_SSTPR              0x68
 122                 #define TPI_CMD_SIN                0x10
 123                 #define TPI_CMD_SOUT               0x90
 124                 #define TPI_CMD_SLDCS              0x80
 125                 #define TPI_CMD_SSTCS              0xC0
 126                 #define TPI_CMD_SKEY               0xE0
 127
 128                 #define TPI_STATUS_REG             0x00
 129                 #define TPI_CTRL_REG               0x02
 130                 #define TPI_ID_REG                 0x0F
 131
 132                 #define TPI_STATUS_NVM             (1 << 1)
 133
 134                 #define TPI_NVMENABLE_KEY          (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
 135
 136                 #define TPI_POINTER_INDIRECT       0
 137                 #define TPI_POINTER_INDIRECT_PI    4
 138
 139         /* Function Prototypes: */
 140                 void    XPROGTarget_EnableTargetPDI(void);
 141                 void    XPROGTarget_EnableTargetTPI(void);
 142                 void    XPROGTarget_DisableTargetPDI(void);
 143                 void    XPROGTarget_DisableTargetTPI(void);
 144                 void    XPROGTarget_SendByte(const uint8_t Byte);
 145                 uint8_t XPROGTarget_ReceiveByte(void);
 146                 void    XPROGTarget_SendBreak(void);
 147                 bool    XPROGTarget_WaitWhileNVMBusBusy(void);
 148
 149                 #if defined(INCLUDE_FROM_XPROGTARGET_C)
 150                         static void XPROGTarget_SetTxMode(void);
 151                         static void XPROGTarget_SetRxMode(void);
 152                 #endif
 153
 154 #endif