Subversion Repositories or1k

/*

/*

 * Copyright (C) 1995 Advanced RISC Machines Limited. All rights reserved.

 * Copyright (C) 1995 Advanced RISC Machines Limited. All rights reserved.

 *

 *

 * This software may be freely used, copied, modified, and distributed

 * This software may be freely used, copied, modified, and distributed

 * provided that the above copyright notice is preserved in all copies of the

 * provided that the above copyright notice is preserved in all copies of the

 * software.

 * software.

 */

 */

/* -*-C-*-

/* -*-C-*-

 *

 *

 * $Revision: 1.1.1.1 $

 * $Revision: 1.1.1.1 $

 *     $Date: 2001-05-18 11:16:30 $

 *     $Date: 2001-05-18 11:16:30 $

 *

 *

 *

 *

 *

 *

 * INTRODUCTION

 * INTRODUCTION

 * ------------

 * ------------

 * The early RDP message definitions were held in an ARM Ltd "armdbg"

 * The early RDP message definitions were held in an ARM Ltd "armdbg"

 * source file. Since the relevant header files were not exported

 * source file. Since the relevant header files were not exported

 * publicly as part of an ARM Ltd core tools release, it was a problem

 * publicly as part of an ARM Ltd core tools release, it was a problem

 * for developers manipulating the target side of the protocol.

 * for developers manipulating the target side of the protocol.

 *

 *

 * For Angel, this new (ANSI 'C' clean) header file defines the ADP

 * For Angel, this new (ANSI 'C' clean) header file defines the ADP

 * protocol. The header should be useable by both host and target

 * protocol. The header should be useable by both host and target

 * systems, thus avoiding problems that can arise from duplicate

 * systems, thus avoiding problems that can arise from duplicate

 * definitions. Care has been taken in the construction of this header

 * definitions. Care has been taken in the construction of this header

 * file to avoid any host/target differences.

 * file to avoid any host/target differences.

 *

 *

 * MESSAGE FORMAT

 * MESSAGE FORMAT

 * --------------

 * --------------

 * Format of the "data" section of debug and boot agent messages. This is

 * Format of the "data" section of debug and boot agent messages. This is

 * the standard ADP (Angel Debug Protocol) message format:

 * the standard ADP (Angel Debug Protocol) message format:

 *

 *

 *  unsigned32 reason     - Main debug reason code.

 *  unsigned32 reason     - Main debug reason code.

 *  unsigned32 debugID    - Information describing host debug world;

 *  unsigned32 debugID    - Information describing host debug world;

 *                        - private to host and used in any target initiated

 *                        - private to host and used in any target initiated

 *                          messages.

 *                          messages.

 *  unsigned32 OSinfo1    \ Target OS information to identify process/thread

 *  unsigned32 OSinfo1    \ Target OS information to identify process/thread

 *  unsigned32 OSinfo2    / memory/world, etc. These two fields are target

 *  unsigned32 OSinfo2    / memory/world, etc. These two fields are target

 *                          defined.

 *                          defined.

 *  byte       args[n]    - Data for message "reason" code.

 *  byte       args[n]    - Data for message "reason" code.

 *

 *

 * NOTE: The message format is the same for single threaded debugging,

 * NOTE: The message format is the same for single threaded debugging,

 * except that the "OSinfo" fields should be -1 (0xFFFFFFFF). Even

 * except that the "OSinfo" fields should be -1 (0xFFFFFFFF). Even

 * single-threaded debugging *MAY* have different host specified

 * single-threaded debugging *MAY* have different host specified

 * debugID values, so the Angel debug system will preserve the "debugID"

 * debugID values, so the Angel debug system will preserve the "debugID"

 * information for replies, and the relevant asynchronous target-to-host

 * information for replies, and the relevant asynchronous target-to-host

 * messages. The "debugID" is defined by the host-end of the

 * messages. The "debugID" is defined by the host-end of the

 * protocol, and is used by the host to ensure that messages are

 * protocol, and is used by the host to ensure that messages are

 * routed to the correct handler program/veneer.

 * routed to the correct handler program/veneer.

 *

 *

 * The reason there are two target specified "OSinfo" words is because

 * The reason there are two target specified "OSinfo" words is because

 * thread identifiers may not be unique when processes/tasks have

 * thread identifiers may not be unique when processes/tasks have

 * private virtual address spaces. It allows more flexibility when

 * private virtual address spaces. It allows more flexibility when

 * supporting multi-threaded or O/S aware debugging.

 * supporting multi-threaded or O/S aware debugging.

 *

 *

 * NOTE: The reason that there is no "size" information, is that the

 * NOTE: The reason that there is no "size" information, is that the

 * message IDs themselves encode the format of any arguments. Also it

 * message IDs themselves encode the format of any arguments. Also it

  * would be a duplication of information used by the physical

  * would be a duplication of information used by the physical

 * transport layer (which is distinct from this logical message

 * transport layer (which is distinct from this logical message

 * layer). Any routing of messages through programs, hosts,

 * layer). Any routing of messages through programs, hosts,

 * etc. should be performed at the physical layer, or the boundaries

 * etc. should be performed at the physical layer, or the boundaries

 * between physical layers. i.e. packet received on socket in host,

 * between physical layers. i.e. packet received on socket in host,

 * and transferred to serial packet for passing on down the line.

 * and transferred to serial packet for passing on down the line.

 *

 *

 * NOTE: Pointers aren't passed in messages because they are dangerous in

 * NOTE: Pointers aren't passed in messages because they are dangerous in

 * a multi-threaded environment.

 * a multi-threaded environment.

 *

 *

 * ADP REASON CODE

 * ADP REASON CODE

 * ---------------

 * ---------------

 * The message reason codes contain some information that ties them to

 * The message reason codes contain some information that ties them to

 * the channel and direction that the message will be used with. This

 * the channel and direction that the message will be used with. This

 * will ensure that even if the message "#define name" is not

 * will ensure that even if the message "#define name" is not

 * completely descriptive, the message reason code is.

 * completely descriptive, the message reason code is.

 *

 *

 *      b31    = direction. 0=Host-to-Target; 1=Target-to-Host;

 *      b31    = direction. 0=Host-to-Target; 1=Target-to-Host;

 *      b30-28 = debug agent multi-threaded control (see below)

 *      b30-28 = debug agent multi-threaded control (see below)

 *      b27-24 = reserved. should be zero.

 *      b27-24 = reserved. should be zero.

 *      b23-16 = channelid. The fixed Angel channel number

 *      b23-16 = channelid. The fixed Angel channel number

 *               (see "channels.h").

 *               (see "channels.h").

 *      b15-0  = message reason code.

 *      b15-0  = message reason code.

 *

 *

 * It is unfortunate that to aid the error-checking capabilities of

 * It is unfortunate that to aid the error-checking capabilities of

 * the Angel communications we have changed the message numbers from

 * the Angel communications we have changed the message numbers from

 * the original ARM Ltd RDP. However this also has benefits, in that

 * the original ARM Ltd RDP. However this also has benefits, in that

 * the Angel work is meant to be a clean break.

 * the Angel work is meant to be a clean break.

 *

 *

 * However, it isn't so bad since even though the numbers are

 * However, it isn't so bad since even though the numbers are

 * different, the majority of the reason codes have exactly the same

 * different, the majority of the reason codes have exactly the same

 * functionality as the original RDP messages.

 * functionality as the original RDP messages.

 *

 *

 * NOTES

 * NOTES

 * -----

 * -----

 * It would be ideal to use "rpcgen" (or some equivalent) to

 * It would be ideal to use "rpcgen" (or some equivalent) to

 * automatically maintain compatibility between the target and host

 * automatically maintain compatibility between the target and host

 * ends of the protocol. However, ARM Ltd expressed that the message

 * ends of the protocol. However, ARM Ltd expressed that the message

 * handling should be hand-coded, to avoid dependance on external

 * handling should be hand-coded, to avoid dependance on external

 * tools.

 * tools.

 *

 *

 * All other channels have undefined data formats and are purely

 * All other channels have undefined data formats and are purely

 * application defined. The C library "_sys_" support will provide a

 * application defined. The C library "_sys_" support will provide a

 * veneer to perform message block operations as required.

 * veneer to perform message block operations as required.

 *

 *

 * It is IMPLIED that all of the ADP messages will fit within the

 * It is IMPLIED that all of the ADP messages will fit within the

 * buffer DATASIZE. This has a minimum value, calculated from

 * buffer DATASIZE. This has a minimum value, calculated from

 * BUFFERMINSIZE.

 * BUFFERMINSIZE.

 *

 *

 * All messages are passed and received to the channel system in little

 * All messages are passed and received to the channel system in little

 * endian order (ie. use little endian order when writing a word as

 * endian order (ie. use little endian order when writing a word as

 * a sequence of bytes within a message).

 * a sequence of bytes within a message).

 *

 *

 * A reply / acknowledgement to an ADP message is always sent and has the

 * A reply / acknowledgement to an ADP message is always sent and has the

 * same reason code as the original except that the TtoH / HtoT bit is

 * same reason code as the original except that the TtoH / HtoT bit is

 * reversed.  This makes it simple to check that the reply really

 * reversed.  This makes it simple to check that the reply really

 * is a reply to the message which was just sent!  [Boot Channel messages

 * is a reply to the message which was just sent!  [Boot Channel messages

 * also require that this protocol is used].

 * also require that this protocol is used].

 */

 */

#ifndef angel_adp_h

#ifndef angel_adp_h

#define angel_adp_h

#define angel_adp_h

#include "chandefs.h"

#include "chandefs.h"

/*

/*

 * Buffer minimum sizes

 * Buffer minimum sizes

 */

 */

/* the minimum target internal size */

/* the minimum target internal size */

#define ADP_BUFFER_MIN_SIZE (256)

#define ADP_BUFFER_MIN_SIZE (256)

/* a word is always reserved for internal use in the target */

/* a word is always reserved for internal use in the target */

#define ADP_BUFFER_MAX_INTERNAL (sizeof(word))

#define ADP_BUFFER_MAX_INTERNAL (sizeof(word))

/* the minimum available data portion */

/* the minimum available data portion */

#define ADP_BUFFER_MIN_DATASIZE \

#define ADP_BUFFER_MIN_DATASIZE \

    (ADP_BUFFER_MIN_SIZE - ADP_BUFFER_MAX_INTERNAL - CHAN_HEADER_SIZE)

    (ADP_BUFFER_MIN_SIZE - ADP_BUFFER_MAX_INTERNAL - CHAN_HEADER_SIZE)

/*

/*

 * the space taken up by the standard ADP header

 * the space taken up by the standard ADP header

 * (reason, debugID, OSinfo1, OSinfo2)

 * (reason, debugID, OSinfo1, OSinfo2)

 */

 */

#define ADP_DEFAULT_HEADER_SIZE (4*sizeof(word))

#define ADP_DEFAULT_HEADER_SIZE (4*sizeof(word))

/* 8bit ADP version identification */

/* 8bit ADP version identification */

#define ADPVSN  (0x03)

#define ADPVSN  (0x03)

/* This value can be used to identify the protocol version supported

/* This value can be used to identify the protocol version supported

 * by target or host systems. This version number should only be

 * by target or host systems. This version number should only be

 * changed if the protocol undergoes a non-backward compatible

 * changed if the protocol undergoes a non-backward compatible

 * change. It should *NOT* be used to reflect extensions to the

 * change. It should *NOT* be used to reflect extensions to the

 * protocol. Such extensions can be added to the existing protocol

 * protocol. Such extensions can be added to the existing protocol

 * version by allocating new reason codes, and by extending the

 * version by allocating new reason codes, and by extending the

 * ADP_Info message to identify new features.

 * ADP_Info message to identify new features.

 */

 */

/* The following value is used in the OSinfo fields for

/* The following value is used in the OSinfo fields for

 * single-threaded messages, or where the host wants to alter the

 * single-threaded messages, or where the host wants to alter the

 * global CPU state. NOTE: The "debugID" field should always be

 * global CPU state. NOTE: The "debugID" field should always be

 * defined by the host, and returned in target initiated messages. The

 * defined by the host, and returned in target initiated messages. The

 * only exception to this rule is the ADP_Booted message at the

 * only exception to this rule is the ADP_Booted message at the

 * start-of-day.

 * start-of-day.

 */

 */

#define ADP_HandleUnknown (-1)

#define ADP_HandleUnknown (-1)

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

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

 *

 *

 * ADP reason code subfields

 * ADP reason code subfields

 *

 *

 */

 */

/* The following bits are used to describe the basic direction of

/* The following bits are used to describe the basic direction of

 * messages. This allows some extra checking of message validity to be

 * messages. This allows some extra checking of message validity to be

 * performed, as well as providing a description of the message that

 * performed, as well as providing a description of the message that

 * may not be available in the "cpp" macro:

 * may not be available in the "cpp" macro:

 */

 */

#define HtoT    ((unsigned)0 << 31)     /* Host-to-Target message */

#define HtoT    ((unsigned)0 << 31)     /* Host-to-Target message */

#define TtoH    ((unsigned)1 << 31)     /* Target-to-Host message */

#define TtoH    ((unsigned)1 << 31)     /* Target-to-Host message */

/* The following bits are used to control how the target system

/* The following bits are used to control how the target system

 * executes whilst processing messages. This allows for O/S specific

 * executes whilst processing messages. This allows for O/S specific

 * host-based debug programs to interrogate system structures whilst

 * host-based debug programs to interrogate system structures whilst

 * ensuring that the access is atomic within the constraints imposed

 * ensuring that the access is atomic within the constraints imposed

 * by the target O/S.

 * by the target O/S.

 *

 *

 * NOTE: That only the channel is inserted into the reason code

 * NOTE: That only the channel is inserted into the reason code

 * automatically.  Thus both direction and multi thread control bits

 * automatically.  Thus both direction and multi thread control bits

 * must be added by the host / target.

 * must be added by the host / target.

 */

 */

/* Disable FIQ whilst processing message */

/* Disable FIQ whilst processing message */

#define DisableFIQ              (1 << 30)

#define DisableFIQ              (1 << 30)

/* Disable IRQ whilst processing message */

/* Disable IRQ whilst processing message */

#define DisableIRQ              (1 << 29)

#define DisableIRQ              (1 << 29)

/* Disable O/S pre-emption whilst processing message */

/* Disable O/S pre-emption whilst processing message */

#define DisablePreemption       (1 << 28)

#define DisablePreemption       (1 << 28)

/* The channel identification number is held in the reason code as a

/* The channel identification number is held in the reason code as a

 * check:

 * check:

 */

 */

#define ADPCHANNEL(b)   (((b) & 0xFF) << 16)

#define ADPCHANNEL(b)   (((b) & 0xFF) << 16)

/* The following macro constructs the reason code number, from the

/* The following macro constructs the reason code number, from the

 * various fields - note that the direction is NOT inlcuded since

 * various fields - note that the direction is NOT inlcuded since

 * this depends on whether the Host or Target system is including

 * this depends on whether the Host or Target system is including

 * this file!

 * this file!

 */

 */

#define ADPREASON(c,r)        (ADPCHANNEL(c) | ((r) & 0xFFFF))

#define ADPREASON(c,r)        (ADPCHANNEL(c) | ((r) & 0xFFFF))

/* This macros is used when constructing manifests for sub-reason

/* This macros is used when constructing manifests for sub-reason

 * codes. At the moment it is identical to the main reason macro. If

 * codes. At the moment it is identical to the main reason macro. If

 * desired we could add a new bit that explicitly identifies the value

 * desired we could add a new bit that explicitly identifies the value

 * as a sub-reason code, where the corresponding bit in the main

 * as a sub-reason code, where the corresponding bit in the main

 * message ID would be zero.

 * message ID would be zero.

 */

 */

#define ADPSUBREASON(c,r)     (ADPCHANNEL(c) | ((r) & 0xFFFF))

#define ADPSUBREASON(c,r)     (ADPCHANNEL(c) | ((r) & 0xFFFF))

/* All other undefined bits are reserved, and should be zero. */

/* All other undefined bits are reserved, and should be zero. */

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

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

 *

 *

 * channel_BOOT messages

 * channel_BOOT messages

 *

 *

 */

 */

/* The BOOT agent only supports a few messages. They are used purely

/* The BOOT agent only supports a few messages. They are used purely

 * to control the "start-of-day" connection to a host program. All

 * to control the "start-of-day" connection to a host program. All

 * Angel systems with host communications *MUST* provide the BOOT

 * Angel systems with host communications *MUST* provide the BOOT

 * agent, even if they don't have support for either the single- or

 * agent, even if they don't have support for either the single- or

 * multi-threaded debug agents.

 * multi-threaded debug agents.

 *

 *

 * The way the BOOT channel will be used on startup will be as follows:

 * The way the BOOT channel will be used on startup will be as follows:

 *

 *

 * a) Target board is powered up before host debugger is invoked

 * a) Target board is powered up before host debugger is invoked

 *

 *

 * After switching on the target and initialisation is completed the

 * After switching on the target and initialisation is completed the

 * target will send an ADP_Booted or ADP_Reset message.  The debugger

 * target will send an ADP_Booted or ADP_Reset message.  The debugger

 * has not been started yet so this message will not be received.  In

 * has not been started yet so this message will not be received.  In

 * a serial world this makes it important that any buffers on the host

 * a serial world this makes it important that any buffers on the host

 * side are flushed during initialisation of the debugger, and in an

 * side are flushed during initialisation of the debugger, and in an

 * Ethernet world it makes it important that the target can cope with the

 * Ethernet world it makes it important that the target can cope with the

 * message not being received.

 * message not being received.

 *

 *

 * Eventually the Debugger will be started up and will send an

 * Eventually the Debugger will be started up and will send an

 * ADP_Reboot or ADP_Reset request.  The target will respond to this with

 * ADP_Reboot or ADP_Reset request.  The target will respond to this with

 * an ADP_Reboot or ADP_Reset acknowldege and will then reboot, finally

 * an ADP_Reboot or ADP_Reset acknowldege and will then reboot, finally

 * sending an ADP_Rebooted when it has done all it needs to do (very little

 * sending an ADP_Rebooted when it has done all it needs to do (very little

 * in the case of ADP_Reset, but completely rebooting in the case of

 * in the case of ADP_Reset, but completely rebooting in the case of

 * ADP_Reboot).  Note that it is important that an ADP_Rebooted message is

 * ADP_Reboot).  Note that it is important that an ADP_Rebooted message is

 * sent so that the Debugger does not attempt to send any data after it has

 * sent so that the Debugger does not attempt to send any data after it has

 * made a request to ADP_Reboot and before it receives an ADP_Rebooted, as

 * made a request to ADP_Reboot and before it receives an ADP_Rebooted, as

 * data can be lost be the target during this time.

 * data can be lost be the target during this time.

 *

 *

 * The target and host are now ready to start a debug session.

 * The target and host are now ready to start a debug session.

 *

 *

 * b) Target board is powered up after host debugger is invoked

 * b) Target board is powered up after host debugger is invoked

 *

 *

 * The debugger will send an ADP_Reboot or ADP_Reset request, but will

 * The debugger will send an ADP_Reboot or ADP_Reset request, but will

 * receive no reply until the target is powered up.

 * receive no reply until the target is powered up.

/ *

/ *

 * When the target is powered up then it will send an ADP_Rebooted

 * When the target is powered up then it will send an ADP_Rebooted

 * message to the debugger.  The debugger should accept this message

 * message to the debugger.  The debugger should accept this message

 * even though it has received no ADP_Reboot or ADP_Reset acknowldege message

 * even though it has received no ADP_Reboot or ADP_Reset acknowldege message

 * from the target.

 * from the target.

 *

 *

 * The target and host are now ready to start a debug session.

 * The target and host are now ready to start a debug session.

 *

 *

 *

 *

 * If at any point during the bootup sequence and ADP messages are

 * If at any point during the bootup sequence and ADP messages are

 * sent down the S_DBG channel then they should be responded to with a

 * sent down the S_DBG channel then they should be responded to with a

 * RDI_NotInitialised error. [This should never happen however].

 * RDI_NotInitialised error. [This should never happen however].

 *

 *

 * An ADP_Boot or ADP Rebooted message should be accepted at

 * An ADP_Boot or ADP Rebooted message should be accepted at

 * any point, since it is possible for a catastrophe to occur (such as

 * any point, since it is possible for a catastrophe to occur (such as

 * disconnecteing the host and target during a debug message) which

 * disconnecteing the host and target during a debug message) which

 * requires that one or other end be reset.

 * requires that one or other end be reset.

 *

 *

 */

 */

/*

/*

 * A list of parameter types - for now just baud rate

 * A list of parameter types - for now just baud rate

 */

 */

typedef enum ADP_Parameter {

typedef enum ADP_Parameter {

    AP_PARAMS_START = 0xC000,

    AP_PARAMS_START = 0xC000,

    AP_BAUD_RATE = AP_PARAMS_START,

    AP_BAUD_RATE = AP_PARAMS_START,

    /* extra parameters go in here */

    /* extra parameters go in here */

#ifdef TEST_PARAMS

#ifdef TEST_PARAMS

    AP_CAFE_MENU,               /* extra just for testing */

    AP_CAFE_MENU,               /* extra just for testing */

#endif

#endif

    AP_PARAMS_END

    AP_PARAMS_END

} ADP_Parameter;

} ADP_Parameter;

#define AP_NUM_PARAMS (AP_PARAMS_END - AP_PARAMS_START)

#define AP_NUM_PARAMS (AP_PARAMS_END - AP_PARAMS_START)

/*

/*

 * Parameter types should have associated semantics which can be represented

 * Parameter types should have associated semantics which can be represented

 * within one word per parameter, or an associated enum for choices.

 * within one word per parameter, or an associated enum for choices.

 *

 *

 * AP_BAUD_RATE: the word contains the exact baud rate, eg. 9600, 38400.

 * AP_BAUD_RATE: the word contains the exact baud rate, eg. 9600, 38400.

 */

 */

/* this is not strictly necessary, but it's an example */

/* this is not strictly necessary, but it's an example */

typedef enum ADP_BaudRate {

typedef enum ADP_BaudRate {

    AB_9600  =  9600,

    AB_9600  =  9600,

    AB_19200 = 19200,

    AB_19200 = 19200,

    AB_38400 = 38400,

    AB_38400 = 38400,

    AB_57600 = 57600,

    AB_57600 = 57600,

    AB_115200 = 115200

    AB_115200 = 115200

} ADP_BaudRate;

} ADP_BaudRate;

#define AB_NUM_BAUD_RATES 5     /* this is more useful, for sizing arrays */

#define AB_NUM_BAUD_RATES 5     /* this is more useful, for sizing arrays */

/* This must be set to the max number of options per parameter type */

/* This must be set to the max number of options per parameter type */

#define AP_MAX_OPTIONS (AB_NUM_BAUD_RATES)

#define AP_MAX_OPTIONS (AB_NUM_BAUD_RATES)

#define ADP_Booted      ADPREASON(CI_TBOOT,0)

#define ADP_Booted      ADPREASON(CI_TBOOT,0)

/* This message is sent by the target after the Angel system has been

/* This message is sent by the target after the Angel system has been

 * initialised.  This message also contains information describing the

 * initialised.  This message also contains information describing the

 * Angel world. The information can then be used to check that the

 * Angel world. The information can then be used to check that the

 * target debug agent and source debugger are compatible.

 * target debug agent and source debugger are compatible.

 *

 *

 * Message arguments:

 * Message arguments:

 *      word    Angel message default buffer size.

 *      word    Angel message default buffer size.

 *      word    Angel message large buffer size (may be same as default)

 *      word    Angel message large buffer size (may be same as default)

 *      word    Angel version ; inc. type (e.g. boot ROM) See (1)

 *      word    Angel version ; inc. type (e.g. boot ROM) See (1)

 *      word    ADP version.  See (2)

 *      word    ADP version.  See (2)

 *      word    ARM Architecture info See (3)

 *      word    ARM Architecture info See (3)

 *      word    ARM CPU information ; including target endianness. See (4)

 *      word    ARM CPU information ; including target endianness. See (4)

 *      word    Target hardware status. See (5)

 *      word    Target hardware status. See (5)

 *      word    Number of bytes in banner message

 *      word    Number of bytes in banner message

 *      bytes   Startup banner message (single-threaded readable

 *      bytes   Startup banner message (single-threaded readable

 *              descriptive text - NOT NULL terminated).

 *              descriptive text - NOT NULL terminated).

 *

 *

 * Reply:

 * Reply:

 *      word    status

 *      word    status

 *

 *

 *      'status' returns RDIError_NoError for success, and otherwise

 *      'status' returns RDIError_NoError for success, and otherwise

 *      indicates an error.

 *      indicates an error.

 */

 */

/* Angel version word [Reference(1)] : */

/* Angel version word [Reference(1)] : */

/* Angel version number is a 16bit BCD value */

/* Angel version number is a 16bit BCD value */

#define ADP_ANGELVSN_MASK           (0x0000FFFF)

#define ADP_ANGELVSN_MASK           (0x0000FFFF)

#define ADP_ANGELVSN_SHIFT          (0)

#define ADP_ANGELVSN_SHIFT          (0)

/* Type of Angel system */

/* Type of Angel system */

#define ADP_ANGELVSN_TYPE_MASK      (0x00FF0000)

#define ADP_ANGELVSN_TYPE_MASK      (0x00FF0000)

#define ADP_ANGELVSN_TYPE_SHIFT     (16)

#define ADP_ANGELVSN_TYPE_SHIFT     (16)

typedef enum {

typedef enum {

 ADP_AngelType_bootROM, /* Simple ROM system providing download capability */

 ADP_AngelType_bootROM, /* Simple ROM system providing download capability */

 ADP_AngelType_appROM,  /* ROM based application */

 ADP_AngelType_appROM,  /* ROM based application */

 ADP_AngelType_appDLOAD,/* Downloaded Angel based application */

 ADP_AngelType_appDLOAD,/* Downloaded Angel based application */

 ADP_AngelType_Last     /* Unknown type. This typedef can be extended */

 ADP_AngelType_Last     /* Unknown type. This typedef can be extended */

                        /* but if the host and target vsns differ */

                        /* but if the host and target vsns differ */

                        /* Then one will spot that it dies not understand */

                        /* Then one will spot that it dies not understand */

} ADP_Angel_Types ;     /* this field and can whinge appropriately */

} ADP_Angel_Types ;     /* this field and can whinge appropriately */

/* First unknown ADP_AngelType */

/* First unknown ADP_AngelType */

#define ADP_ANGELVSN_UNKTYPE_MASK   (0xFF000000)

#define ADP_ANGELVSN_UNKTYPE_MASK   (0xFF000000)

#define ADP_ANGELVSN_UNKYPE_SHIFT   (24)

#define ADP_ANGELVSN_UNKYPE_SHIFT   (24)

/* Currently only 8 bits are used in the word: */

/* Currently only 8 bits are used in the word: */

/* ADP protocol supported by target [Reference (2)] */

/* ADP protocol supported by target [Reference (2)] */

#define ADP_ANGELVSN_ADP_MASK       (0x000000FF)

#define ADP_ANGELVSN_ADP_MASK       (0x000000FF)

#define ADP_ANGELVSN_ADP_SHIFT      (0)

#define ADP_ANGELVSN_ADP_SHIFT      (0)

/* ARM Architecture info: [Reference (3)] */

/* ARM Architecture info: [Reference (3)] */

/* ARM Architecture Verson of target CPU */

/* ARM Architecture Verson of target CPU */

#define ADP_ARM_ARCH_VSN_MASK       (0x000000FF)

#define ADP_ARM_ARCH_VSN_MASK       (0x000000FF)

#define ADP_ARM_ARCH_VSN_SHIFT      (0)

#define ADP_ARM_ARCH_VSN_SHIFT      (0)

/* Does the processor support the Thumb Instruction Set */

/* Does the processor support the Thumb Instruction Set */

#define ADP_ARM_ARCH_THUMB          (0x80000000)

#define ADP_ARM_ARCH_THUMB          (0x80000000)

/* Does the processor support Long Multiplies */

/* Does the processor support Long Multiplies */

#define ADP_ARM_ARCH_LONGMUL        (0x40000000)

#define ADP_ARM_ARCH_LONGMUL        (0x40000000)

/* All other flags are current undefined, and should be zero. */

/* All other flags are current undefined, and should be zero. */

/* The following flags describe the feature set of the processor: */

/* The following flags describe the feature set of the processor: */

/* Set if cpu supports little-endian model [Reference (4)] */

/* Set if cpu supports little-endian model [Reference (4)] */

#define ADP_CPU_LE              (1 << 0)

#define ADP_CPU_LE              (1 << 0)

/* Set if cpu supports big-endian model */

/* Set if cpu supports big-endian model */

#define ADP_CPU_BE              (1 << 1)

#define ADP_CPU_BE              (1 << 1)

/* Set if processor has a cache */

/* Set if processor has a cache */

#define ADP_CPU_CACHE           (1 << 2)

#define ADP_CPU_CACHE           (1 << 2)

/* Set if processor has a MMU */

/* Set if processor has a MMU */

#define ADP_CPU_MMU             (1 << 3)

#define ADP_CPU_MMU             (1 << 3)

/* All other flags are current undefined, and should be zero. */

/* All other flags are current undefined, and should be zero. */

/* The following flags reflect current Target hardware status: */

/* The following flags reflect current Target hardware status: */

/* [Reference (5)] */

/* [Reference (5)] */

/* 0 = no MMU or MMU off; 1 = MMU on */

/* 0 = no MMU or MMU off; 1 = MMU on */

#define ADP_CPU_MMUOn           (1 << 29)

#define ADP_CPU_MMUOn           (1 << 29)

/* 0 = no cache or cache off; 1 = cache on */

/* 0 = no cache or cache off; 1 = cache on */

#define ADP_CPU_CacheOn         (1 << 30)

#define ADP_CPU_CacheOn         (1 << 30)

/* 0 = little-endian; 1 = big-endian */

/* 0 = little-endian; 1 = big-endian */

#define ADP_CPU_BigEndian       (1U << 31)

#define ADP_CPU_BigEndian       (1U << 31)

/* All other flags are current undefined, and should be zero. */

/* All other flags are current undefined, and should be zero. */

#ifdef LINK_RECOVERY

#ifdef LINK_RECOVERY

#define ADP_TargetResetIndication       ADPREASON(CI_TBOOT, 1)

#define ADP_TargetResetIndication       ADPREASON(CI_TBOOT, 1)

/*

/*

 * If parameter negotiation is enabled at the target, it configures itself

 * If parameter negotiation is enabled at the target, it configures itself

 * to various likely parameter settings and sends this message at each

 * to various likely parameter settings and sends this message at each

 * configuration.  The message describes the default settings, and after

 * configuration.  The message describes the default settings, and after

 * sending at each configuration the target sets itself to the defaults

 * sending at each configuration the target sets itself to the defaults

 * it has just broadcast, to await either an ack on TBOOT or a request

 * it has just broadcast, to await either an ack on TBOOT or a request

 * or reset indication on HBOOT.

 * or reset indication on HBOOT.

 *

 *

 * If the host receives this message successfully, it should reset to the

 * If the host receives this message successfully, it should reset to the

 * indicated parameters and send a reply.

 * indicated parameters and send a reply.

 *

 *

 * Message arguments:

 * Message arguments:

 *      word    status                   (always 0, makes body same as

 *      word    status                   (always 0, makes body same as

 *                                        ADP_ParamNegotiate response)

 *                                        ADP_ParamNegotiate response)

 *      word    n-parameters

 *      word    n-parameters

 *      n-parameters * {

 *      n-parameters * {

 *              word    ADP_Parameter

 *              word    ADP_Parameter

 *              word    parameter-value

 *              word    parameter-value

 *      }

 *      }

 *

 *

 * Reply:

 * Reply:

 *      -       empty acknowledgement

 *      -       empty acknowledgement

 */

 */

#endif /* def LINK_RECOVERY */

#endif /* def LINK_RECOVERY */

typedef enum ADP_Boot_Ack {

typedef enum ADP_Boot_Ack {

    AB_NORMAL_ACK,              /* will comply, immediate booted message */

    AB_NORMAL_ACK,              /* will comply, immediate booted message */

    AB_LATE_ACK,                /* will comply, late startup */

    AB_LATE_ACK,                /* will comply, late startup */

    AB_ERROR                    /* cannot comply */

    AB_ERROR                    /* cannot comply */

} ADP_Boot_Ack;

} ADP_Boot_Ack;

/* If the host sets neither of these in the word sent on a Reset / Reboot

/* If the host sets neither of these in the word sent on a Reset / Reboot

 * then it doesn;t care about the endianess of the target

 * then it doesn;t care about the endianess of the target

 */

 */

#define ADP_BootHostFeature_LittleEnd 0x80000000

#define ADP_BootHostFeature_LittleEnd 0x80000000

#define ADP_BootHostFeature_BigEnd    0x40000000

#define ADP_BootHostFeature_BigEnd    0x40000000

#define ADP_Reboot      ADPREASON(CI_HBOOT,2)

#define ADP_Reboot      ADPREASON(CI_HBOOT,2)

/* This message is sent when the host wants the target system to be

/* This message is sent when the host wants the target system to be

 * completely reset, back to the boot monitor Angel. This is the

 * completely reset, back to the boot monitor Angel. This is the

 * method of the host forcing a cold-reboot.

 * method of the host forcing a cold-reboot.

 * Note that an acknowledgement message will be sent immediately and

 * Note that an acknowledgement message will be sent immediately and

 * that this must be sent before the target can reset.

 * that this must be sent before the target can reset.

 *

 *

 * The parameter to this function is a bitset of host supported

 * The parameter to this function is a bitset of host supported

 * features. (in fact the same as ADP_Reset below.  This can be used by

 * features. (in fact the same as ADP_Reset below.  This can be used by

 * the target system to avoid using debug channel bandwidth raising

 * the target system to avoid using debug channel bandwidth raising

 * messages that will be ignored by the host.

 * messages that will be ignored by the host.

 *

 *

 * Parameters:

 * Parameters:

 *      word    host supported features (see above)

 *      word    host supported features (see above)

 *

 *

 * Reply:

 * Reply:

 *      word    status, one of enum ADP_Boot_Ack above.

 *      word    status, one of enum ADP_Boot_Ack above.

 *

 *

 * Currently there are no such features defined, so the word indicating

 * Currently there are no such features defined, so the word indicating

 * host supported features should be set to 0.

 * host supported features should be set to 0.

 */

 */

#define ADP_Reset       ADPREASON(CI_HBOOT,3)

#define ADP_Reset       ADPREASON(CI_HBOOT,3)

/* This message is a request from the host, which should eventually

/* This message is a request from the host, which should eventually

 * result in the "ADP_Booted" message being sent by the target.

 * result in the "ADP_Booted" message being sent by the target.

 * Note that an acknowledgement message will be sent immediately and

 * Note that an acknowledgement message will be sent immediately and

 * that this must be sent before the target can reset.

 * that this must be sent before the target can reset.

 * This reset message is *ALWAYS* treated as a warm boot, with the target

 * This reset message is *ALWAYS* treated as a warm boot, with the target

 * preserving as much state as possible.

 * preserving as much state as possible.

 *

 *

 * The parameter to this function is a bitset of host supported

 * The parameter to this function is a bitset of host supported

 * features. This can be used by the target system to avoid using

 * features. This can be used by the target system to avoid using

 * debug channel bandwitdth raising messages that will be ignored by

 * debug channel bandwitdth raising messages that will be ignored by

 * the host.

 * the host.

 *

 *

 * Parameters:

 * Parameters:

 *      word    host supported features (see above)

 *      word    host supported features (see above)

 *

 *

 * Reply:

 * Reply:

 *      word    status, one of enum ADP_Boot_Ack above.

 *      word    status, one of enum ADP_Boot_Ack above.

 *

 *

 * Currently there are no such features defined, so the word indicating

 * Currently there are no such features defined, so the word indicating

 * host supported features should be set to 0.

 * host supported features should be set to 0.

 */

 */

#ifdef LINK_RECOVERY

#ifdef LINK_RECOVERY

#define ADP_HostResetIndication         ADPREASON(CI_HBOOT, 4)

#define ADP_HostResetIndication         ADPREASON(CI_HBOOT, 4)

/*

/*

 * This is as for ADP_TargetResetIndication, but is sent by the host when

 * This is as for ADP_TargetResetIndication, but is sent by the host when

 * it first starts up in case the target is listening at a non-default

 * it first starts up in case the target is listening at a non-default

 * setting.  Having sent at various configurations, the host then listens

 * setting.  Having sent at various configurations, the host then listens

 * at the defaults it has just broadcast, to await either an ack on HBOOT

 * at the defaults it has just broadcast, to await either an ack on HBOOT

 * or a reset indication on TBOOT.

 * or a reset indication on TBOOT.

 *

 *

 * For arguments and reply, see ADP_TargetResetIndication.

 * For arguments and reply, see ADP_TargetResetIndication.

 */

 */

#endif /* def LINK_RECOVERY */

#endif /* def LINK_RECOVERY */

#define ADP_ParamNegotiate              ADPREASON(CI_HBOOT, 5)

#define ADP_ParamNegotiate              ADPREASON(CI_HBOOT, 5)

/*

/*

 * The host sends this messages to negotiate new parameters with the target.

 * The host sends this messages to negotiate new parameters with the target.

 * For each parameter the host specifies a range of possibilities, starting

 * For each parameter the host specifies a range of possibilities, starting

 * with the most favoured.  All possible combinations of parameters

 * with the most favoured.  All possible combinations of parameters

 * must be valid.

 * must be valid.

 *

 *

 * If the target can operate at a combination of the offered parameters,

 * If the target can operate at a combination of the offered parameters,

 * it will reply with the parameters it is willing to use.  AFTER sending

 * it will reply with the parameters it is willing to use.  AFTER sending

 * the reply, the target switches to this combination.  On receiving the

 * the reply, the target switches to this combination.  On receiving the

 * reply, the host will switch to the new combination and send a LinkCheck

 * reply, the host will switch to the new combination and send a LinkCheck

 * message (see below).

 * message (see below).

 *

 *

 * If the target cannot operate at any combination of the offered parameters,

 * If the target cannot operate at any combination of the offered parameters,

 * it will reply with an error status.

 * it will reply with an error status.

 *

 *

 * Message arguments:

 * Message arguments:

 *      word    n-parameter-blocks

 *      word    n-parameter-blocks

 *      n-parameter-blocks * {

 *      n-parameter-blocks * {

 *              word    ADP_Parameter

 *              word    ADP_Parameter

 *              word    n-options

 *              word    n-options

 *              n-options * { word      parameter-value }

 *              n-options * { word      parameter-value }

 *      }

 *      }

 *

 *

 * Reply:

 * Reply:

 *      word    status

 *      word    status

 *      if (status == RDIError_NoError) {

 *      if (status == RDIError_NoError) {

 *              word    n-parameters

 *              word    n-parameters

 *              n-parameters * {

 *              n-parameters * {

 *                      word    ADP_Parameter

 *                      word    ADP_Parameter

 *                      word    chosen-value

 *                      word    chosen-value

 *              }

 *              }

 *      }

 *      }

 */

 */

#define ADP_LinkCheck                   ADPREASON(CI_HBOOT, 6)

#define ADP_LinkCheck                   ADPREASON(CI_HBOOT, 6)

/*

/*

 * This should be the first message that the host sends after a successful

 * This should be the first message that the host sends after a successful

 * parameter negotiation.  It is really just a 'ping'.

 * parameter negotiation.  It is really just a 'ping'.

 *

 *

 * Message arguments:

 * Message arguments:

 *      -       empty message

 *      -       empty message

 *

 *

 * Reply:

 * Reply:

 *      -       empty acknowledgement

 *      -       empty acknowledgement

 */

 */

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

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

 *

 *

 * CI_HADP messages

 * CI_HADP messages

 *

 *

 */

 */

#define ADP_HADPUnrecognised        ADPREASON(CI_HADP,0)

#define ADP_HADPUnrecognised        ADPREASON(CI_HADP,0)

/* This message is unusual in that it is normally sent in reply to

/* This message is unusual in that it is normally sent in reply to

 * another message which is not understood.  This is an exception

 * another message which is not understood.  This is an exception

 * to the normal protocol which says that a reply must have the

 * to the normal protocol which says that a reply must have the

 * same base reason code as the original.  There is a single reply

 * same base reason code as the original.  There is a single reply

 * parameter which is the reason code which was not understood.

 * parameter which is the reason code which was not understood.

 *

 *

 * As well as being a reply this message can also be sent and will

 * As well as being a reply this message can also be sent and will

 * return as if this message were unrecognised!

 * return as if this message were unrecognised!

 *

 *

 * Parameters:

 * Parameters:

 *      none

 *      none

 *

 *

 * Reply:

 * Reply:

 *      word    reason code which was not recognised

 *      word    reason code which was not recognised

 */

 */

#define ADP_Info                ADPREASON(CI_HADP,1)

#define ADP_Info                ADPREASON(CI_HADP,1)

/* This is the new ADP information message. It is used to interrogate

/* This is the new ADP information message. It is used to interrogate

 * the target debug agent.  It provides information on the processor,

 * the target debug agent.  It provides information on the processor,

 * as well as the state of the debug world. This allows the host to

 * as well as the state of the debug world. This allows the host to

 * configure itself to the capabilities of the target.

 * configure itself to the capabilities of the target.

 *

 *

 * We try not to use feature bitsets, since we could quickly run out

 * We try not to use feature bitsets, since we could quickly run out

 * of known bits.  Thus when the feature set is extended, this can be

 * of known bits.  Thus when the feature set is extended, this can be

 * done in a couple of supported ways:

 * done in a couple of supported ways:

 *

 *

 *  If an undivided reason code is to be added (no reason subcodes)

 *  If an undivided reason code is to be added (no reason subcodes)

 *  then add a new ADP_Info code which responds with a flag indicating

 *  then add a new ADP_Info code which responds with a flag indicating

 *  whether that feature is supported by the target.  If this has not

 *  whether that feature is supported by the target.  If this has not

 *  even been implemented then the reply will be ADP_HADPUnrecognised

 *  even been implemented then the reply will be ADP_HADPUnrecognised

 *

 *

 *  If a reason code which is subdivided into reason subcodes is

 *  If a reason code which is subdivided into reason subcodes is

 *  added then reason subcode 0 should be set aside to indicate

 *  added then reason subcode 0 should be set aside to indicate

 *  whether the functionality of that reason code is supported

 *  whether the functionality of that reason code is supported

 *  by the target.  If it is not even implemented then the reply will

 *  by the target.  If it is not even implemented then the reply will

 *  be ADP_Unrecognised.

 *  be ADP_Unrecognised.

 *

 *

 * The first parameter to ADP_Info is a reason subcode, and subsequent

 * The first parameter to ADP_Info is a reason subcode, and subsequent

 * parameters are defined by that subcode

 * parameters are defined by that subcode

 *

 *

 * Parameters:

 * Parameters:

 *      word         reason subcode

 *      word         reason subcode

 *      other arguments as reason subcode determines.

 *      other arguments as reason subcode determines.

 *

 *

 * Reply:

 * Reply:

 *      word         reason subcode

 *      word         reason subcode

 *      other argument as reason subcode determines

 *      other argument as reason subcode determines

 */

 */

/* ADP_Info reason subcodes: */

/* ADP_Info reason subcodes: */

#define ADP_Info_NOP                    ADPSUBREASON(CI_HADP,0)

#define ADP_Info_NOP                    ADPSUBREASON(CI_HADP,0)

/* ADP_Info_NOP

/* ADP_Info_NOP

 * ------------

 * ------------

 * Summary: This message is used to check for ADP_Info being supported.

 * Summary: This message is used to check for ADP_Info being supported.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status)

 * Return: (word status)

 *

 *

 * 'status' returns RDIError_NoError for success, non-zero indicates an error.

 * 'status' returns RDIError_NoError for success, non-zero indicates an error.

 * If an error is returned then there is no handler for the ADP_Info

 * If an error is returned then there is no handler for the ADP_Info

 * message. The normal action will be to return an OK status.

 * message. The normal action will be to return an OK status.

 */

 */

#define ADP_Info_Target                 ADPSUBREASON(CI_HADP,1)

#define ADP_Info_Target                 ADPSUBREASON(CI_HADP,1)

/* ADP_Info_Target

/* ADP_Info_Target

 * ---------------

 * ---------------

 * Summary:

 * Summary:

 * This reason code is used to interrogate target system details.

 * This reason code is used to interrogate target system details.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status, word bitset, word model)

 * Return: (word status, word bitset, word model)

 *

 *

 * 'status' is RDIError_NoError to indicate OK, or non-zero to indicate

 * 'status' is RDIError_NoError to indicate OK, or non-zero to indicate

 * some sort of error.

 * some sort of error.

 * 'bitset' is described in more detail below, and is mostly compatible

 * 'bitset' is described in more detail below, and is mostly compatible

 * with the old RDI/RDP system to avoid gratuitous changes to the debugger

 * with the old RDI/RDP system to avoid gratuitous changes to the debugger

 * toolbox.

 * toolbox.

 * 'model' is the target hardware ID word, as returned by the ADP_Booted

 * 'model' is the target hardware ID word, as returned by the ADP_Booted

 * message.

 * message.

 *

 *

 * NOTE: The minimum and maximum protocol levels are no longer supported.

 * NOTE: The minimum and maximum protocol levels are no longer supported.

 * It is the Angel view that debugging complexity should be shifted to the

 * It is the Angel view that debugging complexity should be shifted to the

 * host if at all possible.  This means that the host debugger should

 * host if at all possible.  This means that the host debugger should

 * always try to configure itself to the features available in the target

 * always try to configure itself to the features available in the target

 * debug agent.  This can be done by checking individual messages, rather

 * debug agent.  This can be done by checking individual messages, rather

 * than by a blanket version number dictating the feature set.

 * than by a blanket version number dictating the feature set.

 */

 */

/* 'bitset':- */

/* 'bitset':- */

/* Target speed in instructions per second = 10**(bits0..3). */

/* Target speed in instructions per second = 10**(bits0..3). */

#define ADP_Info_Target_LogSpeedMask         (0xF)

#define ADP_Info_Target_LogSpeedMask         (0xF)

/* Target is running on [0 = emulator / 1 = hardware] */

/* Target is running on [0 = emulator / 1 = hardware] */

#define ADP_Info_Target_HW                   (1 << 4)

#define ADP_Info_Target_HW                   (1 << 4)

/* Bits 5..10 are currently undefined and should be zero. */

/* Bits 5..10 are currently undefined and should be zero. */

/* Other bis are kept the same as the RDP in order to */

/* Other bis are kept the same as the RDP in order to */

/* eliminate the need to change the position of some bits */

/* eliminate the need to change the position of some bits */

/* If set then the debug agent can be reloaded. */

/* If set then the debug agent can be reloaded. */

#define ADP_Info_Target_CanReloadAgent       (1 << 11)

#define ADP_Info_Target_CanReloadAgent       (1 << 11)

/* Can request AngelBufferSize information. */

/* Can request AngelBufferSize information. */

#define ADP_Info_Target_CanInquireBufferSize (1 << 12)

#define ADP_Info_Target_CanInquireBufferSize (1 << 12)

/* Bit 13 is no longer required as it inquired whether

/* Bit 13 is no longer required as it inquired whether

 * a special RDP Interrupt code was supported

 * a special RDP Interrupt code was supported

 */

 */

/* Debug agent can perform profiling. */

/* Debug agent can perform profiling. */

#define ADP_Info_Target_Profiling            (1 << 14)

#define ADP_Info_Target_Profiling            (1 << 14)

/* Debug agent can support Thumb code. */

/* Debug agent can support Thumb code. */

#define ADP_Info_Target_Thumb                (1 << 15)

#define ADP_Info_Target_Thumb                (1 << 15)

/* Bit 16 was the communications channel check.

/* Bit 16 was the communications channel check.

 * This is always available on Angel systems.

 * This is always available on Angel systems.

 */

 */

#define ADP_Info_Points                 ADPSUBREASON(CI_HADP,2)

#define ADP_Info_Points                 ADPSUBREASON(CI_HADP,2)

/* ADP_Info_Points

/* ADP_Info_Points

 * ---------------

 * ---------------

 * Summary: Returns a 32bit wide bitset of break- and watch-point

 * Summary: Returns a 32bit wide bitset of break- and watch-point

 * features supported by the target debug agent.

 * features supported by the target debug agent.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status, word breakinfo)

 * Return: (word status, word breakinfo)

 *

 *

 * 'status' returns RDIError_NoError on success or non-zero to indicate

 * 'status' returns RDIError_NoError on success or non-zero to indicate

 * some sort of error.

 * some sort of error.

 * 'breakinfo' is a 32bit wide bitset described in detail below.  Note

 * 'breakinfo' is a 32bit wide bitset described in detail below.  Note

 * that only bits 1..12 are used.

 * that only bits 1..12 are used.

 */

 */

/* 'breakinfo':- */

/* 'breakinfo':- */

/* Can trap on address equality. */

/* Can trap on address equality. */

#define ADP_Info_Points_Comparison      (1 << 0)

#define ADP_Info_Points_Comparison      (1 << 0)

/* Can trap on address range. */

/* Can trap on address range. */

#define ADP_Info_Points_Range           (1 << 1)

#define ADP_Info_Points_Range           (1 << 1)

/* Can trap on 8bit memory reads. */

/* Can trap on 8bit memory reads. */

#define ADP_Info_Points_ReadByteWatch   (1 << 2)

#define ADP_Info_Points_ReadByteWatch   (1 << 2)

/* Can trap on 16bit memory reads. */

/* Can trap on 16bit memory reads. */

#define ADP_Info_Points_ReadHalfWatch   (1 << 3)

#define ADP_Info_Points_ReadHalfWatch   (1 << 3)

/* Can trap on 32bit memory reads. */

/* Can trap on 32bit memory reads. */

#define ADP_Info_Points_ReadWordWatch   (1 << 4)

#define ADP_Info_Points_ReadWordWatch   (1 << 4)

/* Can trap on 8bit write accesses. */

/* Can trap on 8bit write accesses. */

#define ADP_Info_Points_WriteByteWatch  (1 << 5)

#define ADP_Info_Points_WriteByteWatch  (1 << 5)

/* Can trap on 16bit write accesses. */

/* Can trap on 16bit write accesses. */

#define ADP_Info_Points_WriteHalfWatch  (1 << 6)

#define ADP_Info_Points_WriteHalfWatch  (1 << 6)

/* Can trap on 32bit write accesses. */

/* Can trap on 32bit write accesses. */

#define ADP_Info_Points_WriteWordWatch  (1 << 7)

#define ADP_Info_Points_WriteWordWatch  (1 << 7)

/* Like range, but based on address bitmask<. */

/* Like range, but based on address bitmask<. */

#define ADP_Info_Points_Mask            (1 << 8)

#define ADP_Info_Points_Mask            (1 << 8)

/* Multi-threaded support only - thread specific breakpoints. */

/* Multi-threaded support only - thread specific breakpoints. */

#define ADP_Info_Points_ThreadBreak     (1 << 9)

#define ADP_Info_Points_ThreadBreak     (1 << 9)

/* Multi-threaded support only - thread specific watchpoints. */

/* Multi-threaded support only - thread specific watchpoints. */

#define ADP_Info_Points_ThreadWatch     (1 << 10)

#define ADP_Info_Points_ThreadWatch     (1 << 10)

/* Allows conditional breakpoints. */

/* Allows conditional breakpoints. */

#define ADP_Info_Points_Conditionals    (1 << 11)

#define ADP_Info_Points_Conditionals    (1 << 11)

/* Break- and watch-points can be interrogated */

/* Break- and watch-points can be interrogated */

#define ADP_Info_Points_Status          (1 << 12)

#define ADP_Info_Points_Status          (1 << 12)

#define ADP_Info_Step                   ADPSUBREASON(CI_HADP,3)

#define ADP_Info_Step                   ADPSUBREASON(CI_HADP,3)

/* ADP_Info_Step

/* ADP_Info_Step

 * -------------

 * -------------

 * Summary: Returns a 32bit wide bitmask of the single-stepping

 * Summary: Returns a 32bit wide bitmask of the single-stepping

 * capabilities of the target debug agent.

 * capabilities of the target debug agent.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status, word stepinfo)

 * Return: (word status, word stepinfo)

 *

 *

 * 'status' returns RDIError_NoError on success, or non-zero to indicate

 * 'status' returns RDIError_NoError on success, or non-zero to indicate

 * some kind of error.

 * some kind of error.

 * 'stepinfo' is a 32bit wide bitmask described in detail below.  Note that

 * 'stepinfo' is a 32bit wide bitmask described in detail below.  Note that

 * only 3 bits are used.

 * only 3 bits are used.

 */

 */

/* 'stepinfo':- */

/* 'stepinfo':- */

/* Single-stepping of more than one instruction is possible. */

/* Single-stepping of more than one instruction is possible. */

#define ADP_Info_Step_Multiple  (1 << 0)

#define ADP_Info_Step_Multiple  (1 << 0)

/* Single-stepping until next direct PC change is possible. */

/* Single-stepping until next direct PC change is possible. */

#define ADP_Info_Step_PCChange  (1 << 1)

#define ADP_Info_Step_PCChange  (1 << 1)

/* Single-stepping of a single instruction is possible. */

/* Single-stepping of a single instruction is possible. */

#define ADP_Info_Step_Single    (1 << 2)

#define ADP_Info_Step_Single    (1 << 2)

#define ADP_Info_MMU                    ADPSUBREASON(CI_HADP,4)

#define ADP_Info_MMU                    ADPSUBREASON(CI_HADP,4)

/* ADP_Info_MMU

/* ADP_Info_MMU

 * ------------

 * ------------

 * Summary: Returns information about the memory management system (if

 * Summary: Returns information about the memory management system (if

 * any).

 * any).

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status, word meminfo)

 * Return: (word status, word meminfo)

 *

 *

 * 'status' returns RDIError_NoError to indicate success or non-zero to

 * 'status' returns RDIError_NoError to indicate success or non-zero to

 * indicate some kind of error.

 * indicate some kind of error.

 * 'meminfo' should be a 32bit unique ID, or zero if there is no MMU

 * 'meminfo' should be a 32bit unique ID, or zero if there is no MMU

 * support on the target.

 * support on the target.

 */

 */

#define ADP_Info_SemiHosting            ADPSUBREASON(CI_HADP,5)

#define ADP_Info_SemiHosting            ADPSUBREASON(CI_HADP,5)

/* ADP_Info_SemiHosting

/* ADP_Info_SemiHosting

 * --------------------

 * --------------------

 * Summary: This message is used to check whether semi-hosting info calls

 * Summary: This message is used to check whether semi-hosting info calls

 * are available on the target.

 * are available on the target.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status)

 * Return: (word status)

 *

 *

 * 'status' returns RDIError_NoError if semi-hosting info calls are available,

 * 'status' returns RDIError_NoError if semi-hosting info calls are available,

 * non-zero otherwise.

 * non-zero otherwise.

 */

 */

#define ADP_Info_CoPro                  ADPSUBREASON(CI_HADP,6)

#define ADP_Info_CoPro                  ADPSUBREASON(CI_HADP,6)

/* ADP_Info_CoPro

/* ADP_Info_CoPro

 * --------------

 * --------------

 * Summary: This message checks whether CoProcessor info calls are

 * Summary: This message checks whether CoProcessor info calls are

 * supported.

 * supported.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status)

 * Return: (word status)

 *

 *

 * 'status' returns RDIError_NoError to indicate these facilities

 * 'status' returns RDIError_NoError to indicate these facilities

 * are supported, non-zero otherwise.

 * are supported, non-zero otherwise.

 */

 */

#define ADP_Info_Cycles                 ADPSUBREASON(CI_HADP,7)

#define ADP_Info_Cycles                 ADPSUBREASON(CI_HADP,7)

/* ADP_Info_Cycles

/* ADP_Info_Cycles

 * ---------------

 * ---------------

 * Summary: Returns the number of instructions and cycles executed since

 * Summary: Returns the number of instructions and cycles executed since

 * the target was initialised.

 * the target was initialised.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   ()

 * Send:   ()

 * Return: (word status, word ninstr, word Scycles, word Ncycles,

 * Return: (word status, word ninstr, word Scycles, word Ncycles,

 *          word Icycles, word Ccycles, word Fcycles)

 *          word Icycles, word Ccycles, word Fcycles)

 *

 *

 * 'status' is RDIError_NoError to indicate success, or non-zero if there

 * 'status' is RDIError_NoError to indicate success, or non-zero if there

 * is no target support for gathering cycle count information.

 * is no target support for gathering cycle count information.

 * 'ninstr' is the number of instructions executed.

 * 'ninstr' is the number of instructions executed.

 * 'Scycles' is the number of S-cycles executed.

 * 'Scycles' is the number of S-cycles executed.

 * 'Ncycles' is the number of N-cycles executed.

 * 'Ncycles' is the number of N-cycles executed.

 * 'Icycles' is the number of I-cycles executed.

 * 'Icycles' is the number of I-cycles executed.

 * 'Ccycles' is the number of C-cycles executed.

 * 'Ccycles' is the number of C-cycles executed.

 * 'Fcycles' is the number of F-cycles executed.

 * 'Fcycles' is the number of F-cycles executed.

 */

 */

#define ADP_Info_DescribeCoPro          ADPSUBREASON(CI_HADP,8)

#define ADP_Info_DescribeCoPro          ADPSUBREASON(CI_HADP,8)

/* ADP_Info_DescribeCoPro

/* ADP_Info_DescribeCoPro

 * ----------------------

 * ----------------------

 * Summary: Describe the registers of a coprocessor.  Use only if

 * Summary: Describe the registers of a coprocessor.  Use only if

 * ADP_Info_CoPro return RDIError_NoError.

 * ADP_Info_CoPro return RDIError_NoError.

 *

 *

 * Arguments:

 * Arguments:

 * Send:   Arguments of the form:

 * Send:   Arguments of the form:

 *         (byte cpno, byte rmin, byte rmax, byte nbytes, byte access,

 *         (byte cpno, byte rmin, byte rmax, byte nbytes, byte access,

 *          byte cprt_r_b0, byte cprt_r_b1, byte cprt_w_b0, byte cprt_w_b1)

 *          byte cprt_r_b0, byte cprt_r_b1, byte cprt_w_b0, byte cprt_w_b1)

 *         And a terminating byte = 0xff.  Must be within maximum buffer size.

 *         And a terminating byte = 0xff.  Must be within maximum buffer size.

 * Return: (word status)

 * Return: (word status)

 *

 *

 * 'cpno' is the number of the coprocessor to be described.

 * 'cpno' is the number of the coprocessor to be described.

 * 'rmin' is the bottom of a range of registers with the same description.

 * 'rmin' is the bottom of a range of registers with the same description.

 * 'rmax' is the top of a range of registers with the same description.

 * 'rmax' is the top of a range of registers with the same description.

 * 'nbytes' is the size of the register.

 * 'nbytes' is the size of the register.

 * 'access' describes access to the register and is described in more detail

 * 'access' describes access to the register and is described in more detail

 * below.

 * below.

 *

 *

 * If bit 2 of access is set:-

 * If bit 2 of access is set:-

 * 'cprt_r0' provides bits 0 to 7, and

 * 'cprt_r0' provides bits 0 to 7, and

 * 'cprt_r1' provides bits 16 to 23 of a CPRT instruction to read the

 * 'cprt_r1' provides bits 16 to 23 of a CPRT instruction to read the

 * register.

 * register.

 * 'cprt_w0' provides bits 0 to 7, and

 * 'cprt_w0' provides bits 0 to 7, and

 * 'cprt_w1' provides bits 16 to 23 of a CPRT instruction to write the

 * 'cprt_w1' provides bits 16 to 23 of a CPRT instruction to write the

 * register.

 * register.

 *

 *

 * Otherwise, 'cprt_r0' provides bits 12 to 15, and 'cprt_r1' bit 22 of CPDT

 * Otherwise, 'cprt_r0' provides bits 12 to 15, and 'cprt_r1' bit 22 of CPDT