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         Endpoint_ClearOUT();
 103         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 104
 105         /* Enable PDI programming mode with the attached target */
 106         PDITarget_EnableTargetPDI();
 107
 108         /* Store the RESET key into the RESET PDI register to keep the XMEGA in reset */
 109         PDITarget_SendByte(PDI_CMD_STCS | PD_RESET_REG);
 110         PDITarget_SendByte(PDI_RESET_KEY);
 111
 112         /* Enable access to the XPROG NVM bus by sending the documented NVM access key to the device */
 113         PDITarget_SendByte(PDI_CMD_KEY);
 114         for (uint8_t i = sizeof(PDI_NVMENABLE_KEY); i > 0; i--)
 115           PDITarget_SendByte(PDI_NVMENABLE_KEY[i - 1]);
 116
 117         /* Poll the STATUS register to check to see if NVM access has been enabled */
 118         uint8_t NVMAttemptsRemaining = 150;
 119         while (NVMAttemptsRemaining)
 120         {
 121                 _delay_ms(1);
 122
 123                 PDITarget_SendByte(PDI_CMD_LDCS | PD_STATUS_REG);
 124                 if (PDITarget_ReceiveByte() & PDI_STATUS_NVM)
 125                   break;
 126
 127                 NVMAttemptsRemaining--;
 128         }
 129
 130         Endpoint_Write_Byte(CMD_XPROG);
 131         Endpoint_Write_Byte(XPRG_CMD_ENTER_PROGMODE);
 132         Endpoint_Write_Byte(NVMAttemptsRemaining ? XPRG_ERR_OK : XPRG_ERR_FAILED);
 133         Endpoint_ClearIN();
 134 }
 135
 136 /** Handler for the XPROG LEAVE_PROGMODE command to terminate the PDI programming connection with
 137  *  the attached device.
 138  */
 139 static void PDIProtocol_LeaveXPROGMode(void)
 140 {
 141         Endpoint_ClearOUT();
 142         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 143
 144         /* Clear the RESET key into the RESET PDI register to allow the XMEGA to run */
 145         PDITarget_SendByte(PDI_CMD_STCS | PD_RESET_REG);
 146         PDITarget_SendByte(0x00);
 147
 148         PDITarget_DisableTargetPDI();
 149
 150         Endpoint_Write_Byte(CMD_XPROG);
 151         Endpoint_Write_Byte(XPRG_CMD_LEAVE_PROGMODE);
 152         Endpoint_Write_Byte(XPRG_ERR_OK);
 153         Endpoint_ClearIN();
 154 }
 155
 156 /** Handler for the XPRG ERASE command to erase a specific memory address space in the attached device. */
 157 static void PDIProtocol_Erase(void)
 158 {
 159         uint8_t ReturnStatus = XPRG_ERR_OK;
 160
 161         struct
 162         {
 163                 uint8_t  MemoryType;
 164                 uint32_t Address;
 165         } Erase_XPROG_Params;
 166
 167         Endpoint_Read_Stream_LE(&Erase_XPROG_Params, sizeof(Erase_XPROG_Params));
 168
 169         Endpoint_ClearOUT();
 170         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 171
 172         // TODO: Send erase command here via PDI protocol
 173
 174         Endpoint_Write_Byte(CMD_XPROG);
 175         Endpoint_Write_Byte(XPRG_CMD_ERASE);
 176         Endpoint_Write_Byte(ReturnStatus);
 177         Endpoint_ClearIN();
 178 }
 179
 180 /** Handler for the XPROG WRITE_MEMORY command to write to a specific memory space within the attached device. */
 181 static void PDIProtocol_WriteMemory(void)
 182 {
 183         uint8_t ReturnStatus = XPRG_ERR_OK;
 184
 185         struct
 186         {
 187                 uint8_t  MemoryType;
 188                 uint32_t Address;
 189                 uint16_t Length;
 190                 uint8_t  ProgData[256];
 191         } WriteMemory_XPROG_Params;
 192
 193         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params, (sizeof(WriteMemory_XPROG_Params) -
 194                                                             sizeof(WriteMemory_XPROG_Params).ProgData));
 195         WriteMemory_XPROG_Params.Address = SwapEndian_32(WriteMemory_XPROG_Params.Address);
 196         WriteMemory_XPROG_Params.Length  = SwapEndian_16(WriteMemory_XPROG_Params.Length);
 197         Endpoint_Read_Stream_LE(&WriteMemory_XPROG_Params.ProgData, WriteMemory_XPROG_Params.Length);
 198
 199         Endpoint_ClearOUT();
 200         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 201
 202         // TODO: Send program command here via PDI protocol
 203
 204         Endpoint_Write_Byte(CMD_XPROG);
 205         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 206         Endpoint_Write_Byte(ReturnStatus);
 207         Endpoint_ClearIN();
 208 }
 209
 210 /** Handler for the XPROG READ_MEMORY command to read data from a specific address space within the
 211  *  attached device.
 212  */
 213 static void PDIProtocol_ReadMemory(void)
 214 {
 215         uint8_t ReturnStatus = XPRG_ERR_OK;
 216
 217         struct
 218         {
 219                 uint8_t  MemoryType;
 220                 uint32_t Address;
 221                 uint16_t Length;
 222         } ReadMemory_XPROG_Params;
 223
 224         Endpoint_Read_Stream_LE(&ReadMemory_XPROG_Params, sizeof(ReadMemory_XPROG_Params));
 225         ReadMemory_XPROG_Params.Address = SwapEndian_32(ReadMemory_XPROG_Params.Address);
 226         ReadMemory_XPROG_Params.Length  = SwapEndian_16(ReadMemory_XPROG_Params.Length);
 227
 228         Endpoint_ClearOUT();
 229         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 230
 231         // TODO: Send read command here via PDI protocol
 232
 233         Endpoint_Write_Byte(CMD_XPROG);
 234         Endpoint_Write_Byte(XPRG_CMD_READ_MEM);
 235         Endpoint_Write_Byte(ReturnStatus);
 236
 237         Endpoint_ClearIN();
 238 }
 239
 240 /** Handler for the XPROG CRC command to read a specific memory space's CRC value for comparison between the
 241  *  attached device's memory and a data set on the host.
 242  */
 243 static void PDIProtocol_ReadCRC(void)
 244 {
 245         uint8_t ReturnStatus = XPRG_ERR_OK;
 246
 247         uint8_t CRCType = Endpoint_Read_Byte();
 248
 249         Endpoint_ClearOUT();
 250         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 251
 252         uint32_t MemoryCRC = 0;
 253
 254         // TODO: Read device CRC for desired memory via PDI protocol
 255
 256         Endpoint_Write_Byte(CMD_XPROG);
 257         Endpoint_Write_Byte(XPRG_CMD_CRC);
 258         Endpoint_Write_Byte(ReturnStatus);
 259
 260         if (ReturnStatus == XPRG_ERR_OK)
 261         {
 262                 Endpoint_Write_Byte(MemoryCRC >> 16);
 263                 Endpoint_Write_Word_LE(MemoryCRC & 0xFFFF);
 264         }
 265
 266         Endpoint_ClearIN();
 267 }
 268
 269 /** Handler for the XPROG SET_PARAM command to set a PDI parameter for use when communicating with the
 270  *  attached device.
 271  */
 272 static void PDIProtocol_SetParam(void)
 273 {
 274         uint8_t ReturnStatus = XPRG_ERR_OK;
 275
 276         uint8_t XPROGParam = Endpoint_Read_Byte();
 277
 278         if (XPROGParam == XPRG_PARAM_NVMBASE)
 279           XPROG_Param_NVMBase = Endpoint_Read_DWord_LE();
 280         else if (XPROGParam == XPRG_PARAM_EEPPAGESIZE)
 281           XPROG_Param_EEPageSize = Endpoint_Read_Word_LE();
 282         else
 283           ReturnStatus = XPRG_ERR_FAILED;
 284
 285         Endpoint_ClearOUT();
 286         Endpoint_SetEndpointDirection(ENDPOINT_DIR_IN);
 287
 288         Endpoint_Write_Byte(CMD_XPROG);
 289         Endpoint_Write_Byte(XPRG_CMD_SET_PARAM);
 290         Endpoint_Write_Byte(ReturnStatus);
 291         Endpoint_ClearIN();
 292 }
 293
 294 #endif