Subversion Repositories or1k

/* sh-stub.c -- debugging stub for the Hitachi-SH.

 NOTE!! This code has to be compiled with optimization, otherwise the

 function inlining which generates the exception handlers won't work.

*/

/*   This is originally based on an m68k software stub written by Glenn

     Engel at HP, but has changed quite a bit.

     Modifications for the SH by Ben Lee and Steve Chamberlain

*/

/****************************************************************************

                THIS SOFTWARE IS NOT COPYRIGHTED

   HP offers the following for use in the public domain.  HP makes no

   warranty with regard to the software or it's performance and the

   user accepts the software "AS IS" with all faults.

   HP DISCLAIMS ANY WARRANTIES, EXPRESS OR IMPLIED, WITH REGARD

   TO THIS SOFTWARE INCLUDING BUT NOT LIMITED TO THE WARRANTIES

   OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.

****************************************************************************/

/* Remote communication protocol.

   A debug packet whose contents are <data>

   is encapsulated for transmission in the form:

        $ <data> # CSUM1 CSUM2

        <data> must be ASCII alphanumeric and cannot include characters

        '$' or '#'.  If <data> starts with two characters followed by

        ':', then the existing stubs interpret this as a sequence number.

        CSUM1 and CSUM2 are ascii hex representation of an 8-bit

        checksum of <data>, the most significant nibble is sent first.

        the hex digits 0-9,a-f are used.

   Receiver responds with:

        +       - if CSUM is correct and ready for next packet

        -       - if CSUM is incorrect

   <data> is as follows:

   All values are encoded in ascii hex digits.

        Request         Packet

        read registers  g

        reply           XX....X         Each byte of register data

                                        is described by two hex digits.

                                        Registers are in the internal order

                                        for GDB, and the bytes in a register

                                        are in the same order the machine uses.

                        or ENN          for an error.

        write regs      GXX..XX         Each byte of register data

                                        is described by two hex digits.

        reply           OK              for success

                        ENN             for an error

        write reg       Pn...=r...      Write register n... with value r...,

                                        which contains two hex digits for each

                                        byte in the register (target byte

                                        order).

        reply           OK              for success

                        ENN             for an error

        (not supported by all stubs).

        read mem        mAA..AA,LLLL    AA..AA is address, LLLL is length.

        reply           XX..XX          XX..XX is mem contents

                                        Can be fewer bytes than requested

                                        if able to read only part of the data.

                        or ENN          NN is errno

        write mem       MAA..AA,LLLL:XX..XX

                                        AA..AA is address,

                                        LLLL is number of bytes,

                                        XX..XX is data

        reply           OK              for success

                        ENN             for an error (this includes the case

                                        where only part of the data was

                                        written).

        cont            cAA..AA         AA..AA is address to resume

                                        If AA..AA is omitted,

                                        resume at same address.

        step            sAA..AA         AA..AA is address to resume

                                        If AA..AA is omitted,

                                        resume at same address.

        last signal     ?               Reply the current reason for stopping.

                                        This is the same reply as is generated

                                        for step or cont : SAA where AA is the

                                        signal number.

        There is no immediate reply to step or cont.

        The reply comes when the machine stops.

        It is           SAA             AA is the "signal number"

        or...           TAAn...:r...;n:r...;n...:r...;

                                        AA = signal number

                                        n... = register number

                                        r... = register contents

        or...           WAA             The process exited, and AA is

                                        the exit status.  This is only

                                        applicable for certains sorts of

                                        targets.

        kill request    k

        toggle debug    d               toggle debug flag (see 386 & 68k stubs)

        reset           r               reset -- see sparc stub.

        reserved        <other>         On other requests, the stub should

                                        ignore the request and send an empty

                                        response ($#<checksum>).  This way

                                        we can extend the protocol and GDB

                                        can tell whether the stub it is

                                        talking to uses the old or the new.

        search          tAA:PP,MM       Search backwards starting at address

                                        AA for a match with pattern PP and

                                        mask MM.  PP and MM are 4 bytes.

                                        Not supported by all stubs.

        general query   qXXXX           Request info about XXXX.

        general set     QXXXX=yyyy      Set value of XXXX to yyyy.

        query sect offs qOffsets        Get section offsets.  Reply is

                                        Text=xxx;Data=yyy;Bss=zzz

        console output  Otext           Send text to stdout.  Only comes from

                                        remote target.

        Responses can be run-length encoded to save space.  A '*' means that

        the next character is an ASCII encoding giving a repeat count which

        stands for that many repititions of the character preceding the '*'.

        The encoding is n+29, yielding a printable character where n >=3

        (which is where rle starts to win).  Don't use an n > 126.

        So

        "0* " means the same as "0000".  */

#include <string.h>

#include <setjmp.h>

/* Hitachi SH architecture instruction encoding masks */

#define COND_BR_MASK   0xff00

#define UCOND_DBR_MASK 0xe000

#define UCOND_RBR_MASK 0xf0df

#define TRAPA_MASK     0xff00

#define COND_DISP      0x00ff

#define UCOND_DISP     0x0fff

#define UCOND_REG      0x0f00

/* Hitachi SH instruction opcodes */

#define BF_INSTR       0x8b00

#define BT_INSTR       0x8900

#define BRA_INSTR      0xa000

#define BSR_INSTR      0xb000

#define JMP_INSTR      0x402b

#define JSR_INSTR      0x400b

#define RTS_INSTR      0x000b

#define RTE_INSTR      0x002b

#define TRAPA_INSTR    0xc300

#define SSTEP_INSTR    0xc3ff

/* Hitachi SH processor register masks */

#define T_BIT_MASK     0x0001

/*

 * BUFMAX defines the maximum number of characters in inbound/outbound

 * buffers. At least NUMREGBYTES*2 are needed for register packets.

 */

#define BUFMAX 1024

/*

 * Number of bytes for registers

 */

#define NUMREGBYTES 112         /* 92 */

/*

 * typedef

 */

typedef void (*Function) ();

/*

 * Forward declarations

 */

static int hex (char);

static char *mem2hex (char *, char *, int);

static char *hex2mem (char *, char *, int);

static int hexToInt (char **, int *);

static unsigned char *getpacket (void);

static void putpacket (char *);

static void handle_buserror (void);

static int computeSignal (int exceptionVector);

static void handle_exception (int exceptionVector);

void init_serial();

void putDebugChar (char);

char getDebugChar (void);

/* These are in the file but in asm statements so the compiler can't see them */

void catch_exception_4 (void);

void catch_exception_6 (void);

void catch_exception_9 (void);

void catch_exception_10 (void);

void catch_exception_11 (void);

void catch_exception_32 (void);

void catch_exception_33 (void);

void catch_exception_255 (void);

#define catch_exception_random catch_exception_255 /* Treat all odd ones like 255 */

void breakpoint (void);

#define init_stack_size 8*1024  /* if you change this you should also modify BINIT */

#define stub_stack_size 8*1024

int init_stack[init_stack_size] __attribute__ ((section ("stack"))) = {0};

int stub_stack[stub_stack_size] __attribute__ ((section ("stack"))) = {0};

void INIT ();

void BINIT ();

#define CPU_BUS_ERROR_VEC  9

#define DMA_BUS_ERROR_VEC 10

#define NMI_VEC           11

#define INVALID_INSN_VEC   4

#define INVALID_SLOT_VEC   6

#define TRAP_VEC          32

#define IO_VEC            33

#define USER_VEC         255

char in_nmi;   /* Set when handling an NMI, so we don't reenter */

int dofault;  /* Non zero, bus errors will raise exception */

int *stub_sp;

/* debug > 0 prints ill-formed commands in valid packets & checksum errors */

int remote_debug;

/* jump buffer used for setjmp/longjmp */

jmp_buf remcomEnv;

enum regnames

  {

    R0, R1, R2, R3, R4, R5, R6, R7,

    R8, R9, R10, R11, R12, R13, R14,

    R15, PC, PR, GBR, VBR, MACH, MACL, SR,

    TICKS, STALLS, CYCLES, INSTS, PLR

  };

typedef struct

  {

    short *memAddr;

    short oldInstr;

  }

stepData;

int registers[NUMREGBYTES / 4];

stepData instrBuffer;

char stepped;

static const char hexchars[] = "0123456789abcdef";

static char remcomInBuffer[BUFMAX];

static char remcomOutBuffer[BUFMAX];

char highhex(int  x)

{

  return hexchars[(x >> 4) & 0xf];

}

char lowhex(int  x)

{

  return hexchars[x & 0xf];

}

/*

 * Assembly macros

 */

#define BREAKPOINT()   asm("trapa       #0x20"::);

/*

 * Routines to handle hex data

 */

static int

hex (char ch)

{

  if ((ch >= 'a') && (ch <= 'f'))

    return (ch - 'a' + 10);

  if ((ch >= '0') && (ch <= '9'))

    return (ch - '0');

  if ((ch >= 'A') && (ch <= 'F'))

    return (ch - 'A' + 10);

  return (-1);

}

/* convert the memory, pointed to by mem into hex, placing result in buf */

/* return a pointer to the last char put in buf (null) */

static char *

mem2hex (char *mem, char *buf, int count)

{

  int i;

  int ch;

  for (i = 0; i < count; i++)

    {

      ch = *mem++;

      *buf++ = highhex (ch);

      *buf++ = lowhex (ch);

    }

  *buf = 0;

  return (buf);

}

/* convert the hex array pointed to by buf into binary, to be placed in mem */

/* return a pointer to the character after the last byte written */

static char *

hex2mem (char *buf, char *mem, int count)

{

  int i;

  unsigned char ch;

  for (i = 0; i < count; i++)

    {

      ch = hex (*buf++) << 4;

      ch = ch + hex (*buf++);

      *mem++ = ch;

    }

  return (mem);

}

/**********************************************/

/* WHILE WE FIND NICE HEX CHARS, BUILD AN INT */

/* RETURN NUMBER OF CHARS PROCESSED           */

/**********************************************/

static int

hexToInt (char **ptr, int *intValue)

{

  int numChars = 0;

  int hexValue;

  *intValue = 0;

  while (**ptr)

    {

      hexValue = hex (**ptr);

      if (hexValue >= 0)

        {

          *intValue = (*intValue << 4) | hexValue;

          numChars++;

        }

      else

        break;

      (*ptr)++;

    }

  return (numChars);

}

/*

 * Routines to get and put packets

 */

/* scan for the sequence $<data>#<checksum>     */

char *

getpacket (void)

{

  unsigned char *buffer = &remcomInBuffer[0];

  unsigned char checksum;

  unsigned char xmitcsum;

  int count;

  char ch;

  while (1)

    {

      /* wait around for the start character, ignore all other characters */

      while ((ch = getDebugChar ()) != '$')

        ;

retry:

      checksum = 0;

      xmitcsum = -1;

      count = 0;

      /* now, read until a # or end of buffer is found */

      while (count < BUFMAX)

        {

          ch = getDebugChar ();

          if (ch == '$')

            goto retry;

          if (ch == '#')

            break;

          checksum = checksum + ch;

          buffer[count] = ch;

          count = count + 1;

        }

      buffer[count] = 0;

      if (ch == '#')

        {

          ch = getDebugChar ();

          xmitcsum = hex (ch) << 4;

          ch = getDebugChar ();

          xmitcsum += hex (ch);

          if (checksum != xmitcsum)

            {

              putDebugChar ('-');       /* failed checksum */

            }

          else

            {

              putDebugChar ('+');       /* successful transfer */

              /* if a sequence char is present, reply the sequence ID */

              if (buffer[2] == ':')

                {

                  putDebugChar (buffer[0]);

                  putDebugChar (buffer[1]);

                  return &buffer[3];

                }

              return &buffer[0];

            }

        }

    }

}

/* send the packet in buffer. */

static void

putpacket (register char *buffer)

{

  register  int checksum;

  register  int count;

  /*  $<packet info>#<checksum>. */

  do

    {

      char *src = buffer;

      putDebugChar ('$');

      checksum = 0;

      while (*src)

        {

          int runlen;

          /* Do run length encoding */

          for (runlen = 0; runlen < 100; runlen ++)

            {

              if (src[0] != src[runlen])

                {

                  if (runlen > 3)

                    {

                      int encode;

                      /* Got a useful amount */

                      putDebugChar (*src);

                      checksum += *src;

                      putDebugChar ('*');

                      checksum += '*';

                      checksum += (encode = runlen + ' ' - 4);

                      putDebugChar (encode);

                      src += runlen;

                    }

                  else

                    {

                      putDebugChar (*src);

                      checksum += *src;

                      src++;

                    }

                  break;

                }

            }

        }

      putDebugChar ('#');

      putDebugChar (highhex(checksum));

      putDebugChar (lowhex(checksum));

    }

  while  (getDebugChar() != '+');

}

/* a bus error has occurred, perform a longjmp

   to return execution and allow handling of the error */

void

handle_buserror (void)

{

  longjmp (remcomEnv, 1);

}

/*

 * this function takes the SH-1 exception number and attempts to

 * translate this number into a unix compatible signal value

 */

static int

computeSignal (int exceptionVector)

{

  int sigval;

  switch (exceptionVector)

    {

    case INVALID_INSN_VEC:

      sigval = 4;

      break;

    case INVALID_SLOT_VEC:

      sigval = 4;

      break;

    case CPU_BUS_ERROR_VEC:

      sigval = 10;

      break;

    case DMA_BUS_ERROR_VEC:

      sigval = 10;

      break;

    case NMI_VEC:

      sigval = 2;

      break;

    case TRAP_VEC:

    case USER_VEC:

      sigval = 5;

      break;

    default:

      sigval = 7;               /* "software generated"*/

      break;

    }

  return (sigval);

}

void

doSStep (void)

{

  short *instrMem;

  int displacement;

  int reg;

  unsigned short opcode;

  instrMem = (short *) registers[PC];

  opcode = *instrMem;

  stepped = 1;

  if ((opcode & COND_BR_MASK) == BT_INSTR)

    {

      if (registers[SR] & T_BIT_MASK)

        {

          displacement = (opcode & COND_DISP) << 1;

          if (displacement & 0x80)

            displacement |= 0xffffff00;

          /*

                   * Remember PC points to second instr.

                   * after PC of branch ... so add 4

                   */

          instrMem = (short *) (registers[PC] + displacement + 4);

        }

      else

        instrMem += 1;

    }

  else if ((opcode & COND_BR_MASK) == BF_INSTR)

    {

      if (registers[SR] & T_BIT_MASK)

        instrMem += 1;

      else

        {

          displacement = (opcode & COND_DISP) << 1;

          if (displacement & 0x80)

            displacement |= 0xffffff00;

          /*

                   * Remember PC points to second instr.

                   * after PC of branch ... so add 4

                   */

          instrMem = (short *) (registers[PC] + displacement + 4);

        }

    }

  else if ((opcode & UCOND_DBR_MASK) == BRA_INSTR)

    {

      displacement = (opcode & UCOND_DISP) << 1;

      if (displacement & 0x0800)

        displacement |= 0xfffff000;

      /*

           * Remember PC points to second instr.

           * after PC of branch ... so add 4

           */

      instrMem = (short *) (registers[PC] + displacement + 4);

    }

  else if ((opcode & UCOND_RBR_MASK) == JSR_INSTR)

    {

      reg = (char) ((opcode & UCOND_REG) >> 8);

      instrMem = (short *) registers[reg];

    }

  else if (opcode == RTS_INSTR)

    instrMem = (short *) registers[PR];

  else if (opcode == RTE_INSTR)

    instrMem = (short *) registers[15];

  else if ((opcode & TRAPA_MASK) == TRAPA_INSTR)

    instrMem = (short *) ((opcode & ~TRAPA_MASK) << 2);

  else

    instrMem += 1;

  instrBuffer.memAddr = instrMem;

  instrBuffer.oldInstr = *instrMem;

  *instrMem = SSTEP_INSTR;

}

/* Undo the effect of a previous doSStep.  If we single stepped,

   restore the old instruction. */

void

undoSStep (void)

{

  if (stepped)

    {  short *instrMem;

      instrMem = instrBuffer.memAddr;

      *instrMem = instrBuffer.oldInstr;

    }

  stepped = 0;

}

/*

This function does all exception handling.  It only does two things -

it figures out why it was called and tells gdb, and then it reacts

to gdb's requests.

When in the monitor mode we talk a human on the serial line rather than gdb.

*/

void

gdb_handle_exception (int exceptionVector)

{

  int sigval, stepping;

  int addr, length;

  char *ptr;

  /* reply to host that an exception has occurred */

  sigval = computeSignal (exceptionVector);

  remcomOutBuffer[0] = 'S';

  remcomOutBuffer[1] = highhex(sigval);

  remcomOutBuffer[2] = lowhex (sigval);

  remcomOutBuffer[3] = 0;

  putpacket (remcomOutBuffer);

  /*

   * exception 255 indicates a software trap

   * inserted in place of code ... so back up

   * PC by one instruction, since this instruction

   * will later be replaced by its original one!

   */

  if (exceptionVector == 0xff

      || exceptionVector == 0x20)

    registers[PC] -= 2;

  /*

   * Do the thangs needed to undo

   * any stepping we may have done!

   */

  undoSStep ();

  stepping = 0;

  while (1)

    {

      remcomOutBuffer[0] = 0;

      ptr = getpacket ();

      switch (*ptr++)

        {

        case '?':

          remcomOutBuffer[0] = 'S';

          remcomOutBuffer[1] = highhex (sigval);

          remcomOutBuffer[2] = lowhex (sigval);

          remcomOutBuffer[3] = 0;

          break;

        case 'd':

          remote_debug = !(remote_debug);       /* toggle debug flag */

          break;

        case 'g':               /* return the value of the CPU registers */

          mem2hex ((char *) registers, remcomOutBuffer, NUMREGBYTES);

          break;

        case 'G':               /* set the value of the CPU registers - return OK */

          hex2mem (ptr, (char *) registers, NUMREGBYTES);

          strcpy (remcomOutBuffer, "OK");

          break;

          /* mAA..AA,LLLL  Read LLLL bytes at address AA..AA */

        case 'm':

          if (setjmp (remcomEnv) == 0)

            {

              dofault = 0;

              /* TRY, TO READ %x,%x.  IF SUCCEED, SET PTR = 0 */

              if (hexToInt (&ptr, &addr))

                if (*(ptr++) == ',')

                  if (hexToInt (&ptr, &length))

                    {

                      ptr = 0;

                      mem2hex ((char *) addr, remcomOutBuffer, length);

                    }

              if (ptr)

                strcpy (remcomOutBuffer, "E01");