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