/*$$HEADER*/
|
/*$$HEADER*/
|
/******************************************************************************/
|
/******************************************************************************/
|
/* */
|
/* */
|
/* H E A D E R I N F O R M A T I O N */
|
/* H E A D E R I N F O R M A T I O N */
|
/* */
|
/* */
|
/******************************************************************************/
|
/******************************************************************************/
|
|
|
// Project Name : OpenRISC Debug Proxy
|
// Project Name : OpenRISC Debug Proxy
|
// File Name : gdb.h
|
// File Name : gdb.h
|
// Prepared By : jb, rmd
|
// Prepared By : jb, rmd
|
// Project Start : 2008-10-01
|
// Project Start : 2008-10-01
|
|
|
/*$$COPYRIGHT NOTICE*/
|
/*$$COPYRIGHT NOTICE*/
|
/******************************************************************************/
|
/******************************************************************************/
|
/* */
|
/* */
|
/* C O P Y R I G H T N O T I C E */
|
/* C O P Y R I G H T N O T I C E */
|
/* */
|
/* */
|
/******************************************************************************/
|
/******************************************************************************/
|
/*
|
/*
|
This library is free software; you can redistribute it and/or
|
This library is free software; you can redistribute it and/or
|
modify it under the terms of the GNU Lesser General Public
|
modify it under the terms of the GNU Lesser General Public
|
License as published by the Free Software Foundation;
|
License as published by the Free Software Foundation;
|
version 2.1 of the License, a copy of which is available from
|
version 2.1 of the License, a copy of which is available from
|
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt.
|
http://www.gnu.org/licenses/old-licenses/lgpl-2.1.txt.
|
|
|
This library is distributed in the hope that it will be useful,
|
This library is distributed in the hope that it will be useful,
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
Lesser General Public License for more details.
|
Lesser General Public License for more details.
|
|
|
You should have received a copy of the GNU Lesser General Public
|
You should have received a copy of the GNU Lesser General Public
|
License along with this library; if not, write to the Free Software
|
License along with this library; if not, write to the Free Software
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
*/
|
*/
|
|
|
/*$$CHANGE HISTORY*/
|
/*$$CHANGE HISTORY*/
|
/******************************************************************************/
|
/******************************************************************************/
|
/* */
|
/* */
|
/* C H A N G E H I S T O R Y */
|
/* C H A N G E H I S T O R Y */
|
/* */
|
/* */
|
/******************************************************************************/
|
/******************************************************************************/
|
|
|
// Date Version Description
|
// Date Version Description
|
//------------------------------------------------------------------------
|
//------------------------------------------------------------------------
|
// 081101 First revision, adapted from existing "jp"
|
// 081101 First revision, adapted from existing "jp"
|
// debug proxy. jb, rmd
|
// debug proxy. jb, rmd
|
|
|
#ifndef GDB_H
|
#ifndef GDB_H
|
#define GDB_H
|
#define GDB_H
|
|
|
#include <sys/types.h>
|
#include <sys/types.h>
|
#include <inttypes.h>
|
#include <inttypes.h>
|
|
|
extern void HandleServerSocket(void);
|
extern void HandleServerSocket(void);
|
extern void handle_rsp (void);
|
extern void handle_rsp (void);
|
int GetServerSocket(const char* name, const char* proto, int port);
|
int GetServerSocket(const char* name, const char* proto, int port);
|
extern void JTAGRequest(void);
|
extern void JTAGRequest(void);
|
void setup_or32(void);
|
void setup_or32(void);
|
void gdb_close();
|
void gdb_close();
|
|
|
extern int err;
|
extern int err;
|
|
|
|
extern int kernel_debug;
|
|
|
/* All JTAG chains. */
|
/* All JTAG chains. */
|
enum jtag_chains
|
enum jtag_chains
|
{
|
{
|
SC_GLOBAL, /* 0 Global BS Chain */
|
SC_GLOBAL, /* 0 Global BS Chain */
|
SC_RISC_DEBUG, /* 1 RISC Debug Interface chain */
|
SC_RISC_DEBUG, /* 1 RISC Debug Interface chain */
|
SC_RISC_TEST, /* 2 RISC Test Chain */
|
SC_RISC_TEST, /* 2 RISC Test Chain */
|
SC_TRACE, /* 3 Trace Chain */
|
SC_TRACE, /* 3 Trace Chain */
|
SC_REGISTER, /* 4 Register Chain */
|
SC_REGISTER, /* 4 Register Chain */
|
SC_WISHBONE, /* 5 Memory chain */
|
SC_WISHBONE, /* 5 Memory chain */
|
SC_BLOCK, /* 6 Block Chains */
|
SC_BLOCK, /* 6 Block Chains */
|
};
|
};
|
|
|
/* See JTAG documentation about these. */
|
/* See JTAG documentation about these. */
|
#define JI_SIZE (4)
|
#define JI_SIZE (4)
|
enum jtag_instr
|
enum jtag_instr
|
{
|
{
|
JI_EXTEST,
|
JI_EXTEST,
|
JI_SAMPLE_PRELOAD,
|
JI_SAMPLE_PRELOAD,
|
JI_IDCODE,
|
JI_IDCODE,
|
JI_CHAIN_SELECT,
|
JI_CHAIN_SELECT,
|
JI_INTEST,
|
JI_INTEST,
|
JI_CLAMP,
|
JI_CLAMP,
|
JI_CLAMPZ,
|
JI_CLAMPZ,
|
JI_HIGHZ,
|
JI_HIGHZ,
|
JI_DEBUG,
|
JI_DEBUG,
|
JI_BYPASS = 0xF
|
JI_BYPASS = 0xF
|
};
|
};
|
|
|
/* JTAG registers. */
|
/* JTAG registers. */
|
#define JTAG_MODER (0x0)
|
#define JTAG_MODER (0x0)
|
#define JTAG_TSEL (0x1)
|
#define JTAG_TSEL (0x1)
|
#define JTAG_QSEL (0x2)
|
#define JTAG_QSEL (0x2)
|
#define JTAG_SSEL (0x3)
|
#define JTAG_SSEL (0x3)
|
#define JTAG_RISCOP (0x4)
|
#define JTAG_RISCOP (0x4)
|
#define JTAG_RECWP0 (0x10)
|
#define JTAG_RECWP0 (0x10)
|
#define JTAG_RECBP0 (0x1b)
|
#define JTAG_RECBP0 (0x1b)
|
|
|
/* This is repeated from gdb tm-or1k.h There needs to be
|
/* This is repeated from gdb tm-or1k.h There needs to be
|
a better mechanism for tracking this, but I don't see
|
a better mechanism for tracking this, but I don't see
|
an easy way to share files between modules. */
|
an easy way to share files between modules. */
|
|
|
typedef enum {
|
typedef enum {
|
JTAG_COMMAND_READ = 1,
|
JTAG_COMMAND_READ = 1,
|
JTAG_COMMAND_WRITE = 2,
|
JTAG_COMMAND_WRITE = 2,
|
JTAG_COMMAND_BLOCK_READ = 3,
|
JTAG_COMMAND_BLOCK_READ = 3,
|
JTAG_COMMAND_BLOCK_WRITE = 4,
|
JTAG_COMMAND_BLOCK_WRITE = 4,
|
JTAG_COMMAND_CHAIN = 5,
|
JTAG_COMMAND_CHAIN = 5,
|
} JTAG_proxy_protocol_commands;
|
} JTAG_proxy_protocol_commands;
|
|
|
/* Each transmit structure must begin with an integer
|
/* Each transmit structure must begin with an integer
|
which specifies the type of command. Information
|
which specifies the type of command. Information
|
after this is variable. Make sure to have all information
|
after this is variable. Make sure to have all information
|
aligned properly. If we stick with 32 bit integers, it
|
aligned properly. If we stick with 32 bit integers, it
|
should be portable onto every platform. These structures
|
should be portable onto every platform. These structures
|
will be transmitted across the network in network byte
|
will be transmitted across the network in network byte
|
order.
|
order.
|
*/
|
*/
|
|
|
typedef struct {
|
typedef struct {
|
uint32_t command;
|
uint32_t command;
|
uint32_t length;
|
uint32_t length;
|
uint32_t address;
|
uint32_t address;
|
uint32_t data_H;
|
uint32_t data_H;
|
uint32_t data_L;
|
uint32_t data_L;
|
} JTAGProxyWriteMessage;
|
} JTAGProxyWriteMessage;
|
|
|
typedef struct {
|
typedef struct {
|
uint32_t command;
|
uint32_t command;
|
uint32_t length;
|
uint32_t length;
|
uint32_t address;
|
uint32_t address;
|
} JTAGProxyReadMessage;
|
} JTAGProxyReadMessage;
|
|
|
typedef struct {
|
typedef struct {
|
uint32_t command;
|
uint32_t command;
|
uint32_t length;
|
uint32_t length;
|
uint32_t address;
|
uint32_t address;
|
int32_t nRegisters;
|
int32_t nRegisters;
|
uint32_t data[1];
|
uint32_t data[1];
|
} JTAGProxyBlockWriteMessage;
|
} JTAGProxyBlockWriteMessage;
|
|
|
typedef struct {
|
typedef struct {
|
uint32_t command;
|
uint32_t command;
|
uint32_t length;
|
uint32_t length;
|
uint32_t address;
|
uint32_t address;
|
int32_t nRegisters;
|
int32_t nRegisters;
|
} JTAGProxyBlockReadMessage;
|
} JTAGProxyBlockReadMessage;
|
|
|
typedef struct {
|
typedef struct {
|
uint32_t command;
|
uint32_t command;
|
uint32_t length;
|
uint32_t length;
|
uint32_t chain;
|
uint32_t chain;
|
} JTAGProxyChainMessage;
|
} JTAGProxyChainMessage;
|
|
|
/* The responses are messages specific, however convention
|
/* The responses are messages specific, however convention
|
states the first word should be an error code. Again,
|
states the first word should be an error code. Again,
|
sticking with 32 bit integers should provide maximum
|
sticking with 32 bit integers should provide maximum
|
portability. */
|
portability. */
|
|
|
typedef struct {
|
typedef struct {
|
int32_t status;
|
int32_t status;
|
} JTAGProxyWriteResponse;
|
} JTAGProxyWriteResponse;
|
|
|
typedef struct {
|
typedef struct {
|
int32_t status;
|
int32_t status;
|
uint32_t data_H;
|
uint32_t data_H;
|
uint32_t data_L;
|
uint32_t data_L;
|
} JTAGProxyReadResponse;
|
} JTAGProxyReadResponse;
|
|
|
typedef struct {
|
typedef struct {
|
int32_t status;
|
int32_t status;
|
} JTAGProxyBlockWriteResponse;
|
} JTAGProxyBlockWriteResponse;
|
|
|
typedef struct {
|
typedef struct {
|
int32_t status;
|
int32_t status;
|
int32_t nRegisters;
|
int32_t nRegisters;
|
uint32_t data[1];
|
uint32_t data[1];
|
/* uint32_t data[nRegisters-1] still unread */
|
/* uint32_t data[nRegisters-1] still unread */
|
} JTAGProxyBlockReadResponse;
|
} JTAGProxyBlockReadResponse;
|
|
|
typedef struct {
|
typedef struct {
|
int32_t status;
|
int32_t status;
|
} JTAGProxyChainResponse;
|
} JTAGProxyChainResponse;
|
|
|
|
|
#endif /* GDB_H */
|
#endif /* GDB_H */
|
|
|
