Projects/AVRISP/Lib/PDIProtocol.c

   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 #if defined(ENABLE_PDI_PROTOCOL) || defined(__DOXYGEN__)
  32
  33 #warning PDI Programming Protocol support is incomplete and not currently suitable for use.
  34
  35 /** \file
  36  *
  37  *  PDI Protocol handler, to process V2 Protocol wrapped PDI commands used in Atmel programmer devices.
  38  */
  39
  40 #define  INCLUDE_FROM_PDIPROTOCOL_C
  41 #include "PDIProtocol.h"
  42
  43 uint32_t XPROG_Param_NVMBase;
  44 uint32_t XPROG_Param_EEPageSize;
  45
  46 /** Handler for the CMD_XPROG_SETMODE command, which sets the programmer-to-target protocol used for PDI
  47  *  XMEGA programming (either PDI or JTAG). Only PDI programming is supported.
  48  */
  49 void PDIProtocol_XPROG_SetMode(void)
  50 {
  51         struct
  52         {
  53                 uint8_t Protocol;
  54         } SetMode_XPROG_Params;
  55
  56         Endpoint_Read_Stream_LE(&SetMode_XPROG_Params, sizeof(SetMode_XPROG_Params));
  57
  58         Endpoint_ClearOUT();
  59         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
  60
  61         Endpoint_Write_Byte(CMD_XPROG_SETMODE);
  62         Endpoint_Write_Byte(SetMode_XPROG_Params.Protocol ? STATUS_CMD_FAILED : STATUS_CMD_OK);
  63         Endpoint_ClearIN();
  64 }
  65
  66 /** Handler for the CMD_XPROG command, which wraps up XPROG commands in a V2 wrapper which need to be
  67  *  removed and processed so that the underlying XPROG command can be handled.
  68  */
  69 void PDIProtocol_XPROG_Command(void)
  70 {
  71         uint8_t XPROGCommand = Endpoint_Read_Byte();
  72
  73         switch (XPROGCommand)
  74         {
  75                 case XPRG_CMD_ENTER_PROGMODE:
  76                         PDIProtocol_EnterXPROGMode();
  77                         break;
  78                 case XPRG_CMD_LEAVE_PROGMODE:
  79                         PDIProtocol_LeaveXPROGMode();
  80                         break;
  81                 case XPRG_CMD_ERASE:
  82                         PDIProtocol_Erase();
  83                         break;
  84                 case XPRG_CMD_WRITE_MEM:
  85                         PDIProtocol_WriteMemory();
  86                         break;
  87                 case XPRG_CMD_READ_MEM:
  88                         PDIProtocol_ReadMemory();
  89                         break;
  90                 case XPRG_CMD_CRC:
  91                         PDIProtocol_ReadCRC();
  92                         break;
  93                 case XPRG_CMD_SET_PARAM:
  94                         PDIProtocol_SetParam();
  95                         break;
  96         }
  97 }
  98
  99 /** Handler for the XPROG ENTER_PROGMODE command to establish a PDI connection with the attached device. */
 100 static void PDIProtocol_EnterXPROGMode(void)
 101 {
 102         uint8_t ReturnStatus = XPRG_ERR_OK;
 103
 104         Endpoint_ClearOUT();
 105         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 106
 107         PDIDATA_LINE_DDR  |= PDIDATA_LINE_MASK;
 108         PDICLOCK_LINE_DDR |= PDICLOCK_LINE_MASK;
 109
 110         /* Must hold DATA line high for at least 90nS to enable PDI interface */
 111         PDIDATA_LINE_PORT |= PDIDATA_LINE_MASK;
 112         asm volatile ("NOP"::);
 113         #if (F_CPU > 8000000)
 114         asm volatile ("NOP"::);
 115         #endif
 116
 117         /* Toggle CLOCK line 16 times within 100uS of the original 90nS timeout to keep PDI interface enabled */
 118         for (uint8_t i = 0; i < 16; i++)
 119           TOGGLE_PDI_CLOCK;
 120
 121         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 122         PDITarget_SendByte(PDI_CMD_KEY);
 123         for (uint8_t i = 0; i < 8; i++)
 124           PDITarget_SendByte(PDI_NVMENABLE_KEY[i]);
 125
 126         /* Read out the STATUS register to check that NVM access was successfully enabled */
 127         PDITarget_SendByte(PDI_CMD_LDCS | PD_STATUS_REG);
 128         if (!(PDITarget_ReceiveByte() & PDI_STATUS_NVM))
 129           ReturnStatus = XPRG_ERR_FAILED;
 130
 131         Endpoint_Write_Byte(CMD_XPROG);
 132         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 133         Endpoint_Write_Byte(ReturnStatus);
 134         Endpoint_ClearIN();
 135 }
 136
 137 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 138  *  the attached device.
 139  */
 140 static void PDIProtocol_LeaveXPROGMode(void)
 141 {
 142         Endpoint_ClearOUT();
 143         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 144
 145         /* Set DATA and CLOCK lines to inputs */
 146         PDIDATA_LINE_DDR   &= ~PDIDATA_LINE_MASK;
 147         PDICLOCK_LINE_DDR  &= ~PDICLOCK_LINE_MASK;
 148
 149         /* Tristate DATA and CLOCK lines */
 150         PDIDATA_LINE_PORT  &= ~PDIDATA_LINE_MASK;
 151         PDICLOCK_LINE_PORT &= ~PDICLOCK_LINE_MASK;
 152
 153         Endpoint_Write_Byte(CMD_XPROG);
 154         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 155         Endpoint_Write_Byte(XPRG_ERR_OK);
 156         Endpoint_ClearIN();
 157 }
 158
 159 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 160 static void PDIProtocol_Erase(void)
 161 {
 162         uint8_t ReturnStatus = XPRG_ERR_OK;
 163
 164         struct
 165         {
 166                 uint8_t  MemoryType;
 167                 uint32_t Address;
 168         } Erase_XPROG_Params;
 169
 170         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
 171
 172         Endpoint_ClearOUT();
 173         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 174
 175         // TODO: Send erase command here via PDI protocol
 176
 177         Endpoint_Write_Byte(CMD_XPROG);
 178         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 179         Endpoint_Write_Byte(ReturnStatus);
 180         Endpoint_ClearIN();
 181 }
 182
 183 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 184 static void PDIProtocol_WriteMemory(void)
 185 {
 186         uint8_t ReturnStatus = XPRG_ERR_OK;
 187
 188         struct
 189         {
 190                 uint8_t  MemoryType;
 191                 uint32_t Address;
 192                 uint16_t Length;
 193                 uint8_t  ProgData[256];
 194         } WriteMemory_XPROG_Params;
 195
 196         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 197                                                             sizeof(WriteMemory_XPROG_Params).ProgData));
 198         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 199         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 200         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);
 201
 202         Endpoint_ClearOUT();
 203         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 204
 205         // TODO: Send program command here via PDI protocol
 206
 207         Endpoint_Write_Byte(CMD_XPROG);
 208         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 209         Endpoint_Write_Byte(ReturnStatus);
 210         Endpoint_ClearIN();
 211 }
 212
 213 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 214  *  attached device.
 215  */
 216 static void PDIProtocol_ReadMemory(void)
 217 {
 218         uint8_t ReturnStatus = XPRG_ERR_OK;
 219
 220         struct
 221         {
 222                 uint8_t  MemoryType;
 223                 uint32_t Address;
 224                 uint16_t Length;
 225         } ReadMemory_XPROG_Params;
 226
 227         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 228         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 229         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 230
 231         Endpoint_ClearOUT();
 232         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 233
 234         // TODO: Send read command here via PDI protocol
 235
 236         Endpoint_Write_Byte(CMD_XPROG);
 237         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 238         Endpoint_Write_Byte(ReturnStatus);
 239
 240         Endpoint_ClearIN();
 241 }
 242
 243 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 244  *  attached device's memory and a data set on the host.
 245  */
 246 static void PDIProtocol_ReadCRC(void)
 247 {
 248         uint8_t ReturnStatus = XPRG_ERR_OK;
 249
 250         uint8_t CRCType = Endpoint_Read_Byte();
 251
 252         Endpoint_ClearOUT();
 253         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 254
 255         uint32_t MemoryCRC = 0;
 256
 257         // TODO: Read device CRC for desired memory via PDI protocol
 258
 259         Endpoint_Write_Byte(CMD_XPROG);
 260         Endpoint_Write_Byte(XPRG_CMD_CRC);
 261         Endpoint_Write_Byte(ReturnStatus);
 262
 263         if (ReturnStatus == XPRG_ERR_OK)
 264         {
 265                 Endpoint_Write_Byte(MemoryCRC >> 16);
 266                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 267         }
 268
 269         Endpoint_ClearIN();
 270 }
 271
 272 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 273  *  attached device.
 274  */
 275 static void PDIProtocol_SetParam(void)
 276 {
 277         uint8_t ReturnStatus = XPRG_ERR_OK;
 278
 279         uint8_t XPROGParam = Endpoint_Read_Byte();
 280
 281         if (XPROGParam == XPRG_PARAM_NVMBASE)
 282           XPROG_Param_NVMBase = Endpoint_Read_DWord_LE();
 283         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 284           XPROG_Param_EEPageSize = Endpoint_Read_Word_LE();
 285         else
 286           ReturnStatus = XPRG_ERR_FAILED;
 287
 288         Endpoint_ClearOUT();
 289         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 290
 291         Endpoint_Write_Byte(CMD_XPROG);
 292         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 293         Endpoint_Write_Byte(ReturnStatus);
 294         Endpoint_ClearIN();
 295 }
 296
 297 #endif