Projects/AVRISP/Lib/PDI/PDITarget.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         /* 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                 #if ((BOARD == BOARD_XPLAIN) || (BOARD == BOARD_XPLAIN_REV1))
  58                         #define PDI_VIA_HARDWARE_USART
  59                 #else
  60                         #define BITBANG_PDIDATA_PORT     PORTB
  61                         #define BITBANG_PDIDATA_DDR      DDRB
  62                         #define BITBANG_PDIDATA_PIN      PINB
  63                         #define BITBANG_PDIDATA_MASK     (1 << 3)
  64
  65                         #define BITBANG_PDICLOCK_PORT    RESET_LINE_PORT
  66                         #define BITBANG_PDICLOCK_DDR     RESET_LINE_DDR
  67                         #define BITBANG_PDICLOCK_PIN     RESET_LINE_PIN
  68                         #define BITBANG_PDICLOCK_MASK    RESET_LINE_MASK
  69                 #endif
  70
  71                 /** Total number of bits in a single USART frame */
  72                 #define BITS_IN_PDI_FRAME        12
  73
  74                 /** Timeout in milliseconds of a PDI busy-wait command */
  75                 #define PDI_NVM_TIMEOUT_MS       100
  76
  77                 #define PDI_CMD_LDS              0x00
  78                 #define PDI_CMD_LD               0x20
  79                 #define PDI_CMD_STS              0x40
  80                 #define PDI_CMD_ST               0x60
  81                 #define PDI_CMD_LDCS             0x80
  82                 #define PDI_CMD_REPEAT           0xA0
  83                 #define PDI_CMD_STCS             0xC0
  84                 #define PDI_CMD_KEY              0xE0
  85
  86                 #define PDI_STATUS_REG           0
  87                 #define PDI_RESET_REG            1
  88                 #define PDI_CTRL_REG             2
  89
  90                 #define PDI_STATUS_NVM           (1 << 1)
  91                 #define PDI_RESET_KEY            0x59
  92
  93                 #define PDI_NVMENABLE_KEY        (uint8_t[]){0x12, 0x89, 0xAB, 0x45, 0xCD, 0xD8, 0x88, 0xFF}
  94
  95                 #define PDI_DATSIZE_1BYTE        0
  96                 #define PDI_DATSIZE_2BYTES       1
  97                 #define PDI_DATSIZE_3BYTES       2
  98                 #define PDI_DATSIZE_4BYTES       3
  99
 100                 #define PDI_POINTER_INDIRECT     0
 101                 #define PDI_POINTER_INDIRECT_PI  1
 102                 #define PDI_POINTER_DIRECT       2
 103
 104         /* Function Prototypes: */
 105                 void    PDITarget_EnableTargetPDI(void);
 106                 void    PDITarget_DisableTargetPDI(void);
 107                 void    PDITarget_SendByte(const uint8_t Byte);
 108                 uint8_t PDITarget_ReceiveByte(void);
 109                 void    PDITarget_SendBreak(void);
 110                 bool    PDITarget_WaitWhileNVMBusBusy(void);
 111
 112 #endif