Projects/AVRISP/Lib/TPI/TPITarget.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 TPITarget.c.
  34  */
  35
  36 #ifndef _TPI_TARGET_
  37 #define _TPI_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         /* Preprocessor Checks: */
  47                 #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
  48                         #undef ENABLE_ISP_PROTOCOL
  49                         #undef ENABLE_TPI_PROTOCOL
  50
  51                         #if !defined(ENABLE_PDI_PROTOCOL)
  52                                 #define ENABLE_PDI_PROTOCOL
  53                         #endif
  54                 #endif
  55
  56         /* Defines: */
  57                 #define BITBANG_TPIDATA_PORT     PORTB
  58                 #define BITBANG_TPIDATA_DDR      DDRB
  59                 #define BITBANG_TPIDATA_PIN      PINB
  60                 #define BITBANG_TPIDATA_MASK     (1 << 3)
  61
  62                 #define BITBANG_TPICLOCK_PORT    PORTB
  63                 #define BITBANG_TPICLOCK_DDR     DDRB
  64                 #define BITBANG_TPICLOCK_PIN     PINB
  65                 #define BITBANG_TPICLOCK_MASK    (1 << 1)
  66
  67                 /** Total number of bits in a single USART frame */
  68                 #define BITS_IN_TPI_FRAME        12
  69
  70                 /** Timeout in milliseconds of a PDI busy-wait command */
  71                 #define TPI_NVM_TIMEOUT_MS       100
  72
  73                 #define TPI_CMD_SLD              0x20
  74                 #define TPI_CMD_SST              0x60
  75                 #define TPI_CMD_SSTPR            0x68
  76                 #define TPI_CMD_SIN              0x10
  77                 #define TPI_CMD_SOUT             0x90
  78                 #define TPI_CMD_SLDCS            0x80
  79                 #define TPI_CMD_SSTCS            0xC0
  80                 #define TPI_CMD_SKEY             0xE0
  81
  82                 #define TPI_STATUS_REG           0x00
  83                 #define TPI_CTRL_REG             0x02
  84                 #define TPI_ID_REG               0x0F
  85
  86                 #define TPI_STATUS_NVM           (1 << 1)
  87
  88                 #define TPI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
  89
  90                 #define TPI_POINTER_INDIRECT     0
  91                 #define TPI_POINTER_INDIRECT_PI  (1 << 2)
  92
  93         /* Function Prototypes: */
  94                 void    TPITarget_EnableTargetTPI(void);
  95                 void    TPITarget_DisableTargetTPI(void);
  96                 void    TPITarget_SendByte(const uint8_t Byte);
  97                 uint8_t TPITarget_ReceiveByte(void);
  98                 void    TPITarget_SendBreak(void);
  99                 bool    TPITarget_WaitWhileNVMBusBusy(void);
 100
 101 #endif