mips32: new code for pracc exec
[fw/openocd] / src / target / mips32_pracc.h
1 /***************************************************************************
2  *   Copyright (C) 2008 by Spencer Oliver                                  *
3  *   spen@spen-soft.co.uk                                                  *
4  *                                                                         *
5  *   Copyright (C) 2008 by David T.L. Wong                                 *
6  *                                                                         *
7  *   Copyright (C) 2011 by Drasko DRASKOVIC                                *
8  *   drasko.draskovic@gmail.com                                            *
9  *                                                                         *
10  *   This program is free software; you can redistribute it and/or modify  *
11  *   it under the terms of the GNU General Public License as published by  *
12  *   the Free Software Foundation; either version 2 of the License, or     *
13  *   (at your option) any later version.                                   *
14  *                                                                         *
15  *   This program is distributed in the hope that it will be useful,       *
16  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
17  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
18  *   GNU General Public License for more details.                          *
19  *                                                                         *
20  *   You should have received a copy of the GNU General Public License     *
21  *   along with this program; if not, write to the                         *
22  *   Free Software Foundation, Inc.,                                       *
23  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.           *
24  ***************************************************************************/
25
26 #ifndef MIPS32_PRACC_H
27 #define MIPS32_PRACC_H
28
29 #include <target/mips32.h>
30 #include <target/mips_ejtag.h>
31
32 #define MIPS32_PRACC_FASTDATA_AREA              0xFF200000
33 #define MIPS32_PRACC_FASTDATA_SIZE              16
34 #define MIPS32_PRACC_BASE_ADDR                  0xFF200000
35 #define MIPS32_PRACC_TEXT                               0xFF200200
36 #define MIPS32_PRACC_PARAM_OUT                  0xFF202000
37
38 #define PRACC_UPPER_BASE_ADDR                   (MIPS32_PRACC_BASE_ADDR >> 16)
39 #define PRACC_OUT_OFFSET                        (MIPS32_PRACC_PARAM_OUT - MIPS32_PRACC_BASE_ADDR)
40
41 #define MIPS32_FASTDATA_HANDLER_SIZE    0x80
42 #define UPPER16(uint32_t)                               (uint32_t >> 16)
43 #define LOWER16(uint32_t)                               (uint32_t & 0xFFFF)
44 #define NEG16(v)                                                (((~(v)) + 1) & 0xFFFF)
45 /*#define NEG18(v) (((~(v)) + 1) & 0x3FFFF)*/
46
47 struct pracc_queue_info {
48         int retval;
49         const int max_code;
50         int code_count;
51         int store_count;
52         uint32_t *pracc_list;   /* Code and store addresses */
53 };
54 void pracc_queue_init(struct pracc_queue_info *ctx);
55 void pracc_add(struct pracc_queue_info *ctx, uint32_t addr, uint32_t instr);
56 void pracc_queue_free(struct pracc_queue_info *ctx);
57 int mips32_pracc_queue_exec(struct mips_ejtag *ejtag_info,
58                             struct pracc_queue_info *ctx, uint32_t *buf);
59
60 int mips32_pracc_read_mem(struct mips_ejtag *ejtag_info,
61                 uint32_t addr, int size, int count, void *buf);
62 int mips32_pracc_write_mem(struct mips_ejtag *ejtag_info,
63                 uint32_t addr, int size, int count, const void *buf);
64 int mips32_pracc_fastdata_xfer(struct mips_ejtag *ejtag_info, struct working_area *source,
65                 int write_t, uint32_t addr, int count, uint32_t *buf);
66
67 int mips32_pracc_read_regs(struct mips_ejtag *ejtag_info, uint32_t *regs);
68 int mips32_pracc_write_regs(struct mips_ejtag *ejtag_info, uint32_t *regs);
69
70 int mips32_pracc_exec(struct mips_ejtag *ejtag_info, struct pracc_queue_info *ctx, uint32_t *param_out);
71
72 /**
73  * \b mips32_cp0_read
74  *
75  * Simulates mfc0 ASM instruction (Move From C0),
76  * i.e. implements copro C0 Register read.
77  *
78  * @param[in] ejtag_info
79  * @param[in] val Storage to hold read value
80  * @param[in] cp0_reg Number of copro C0 register we want to read
81  * @param[in] cp0_sel Select for the given C0 register
82  *
83  * @return ERROR_OK on Sucess, ERROR_FAIL otherwise
84  */
85 int mips32_cp0_read(struct mips_ejtag *ejtag_info,
86                 uint32_t *val, uint32_t cp0_reg, uint32_t cp0_sel);
87
88 /**
89  * \b mips32_cp0_write
90  *
91  * Simulates mtc0 ASM instruction (Move To C0),
92  * i.e. implements copro C0 Register read.
93  *
94  * @param[in] ejtag_info
95  * @param[in] val Value to be written
96  * @param[in] cp0_reg Number of copro C0 register we want to write to
97  * @param[in] cp0_sel Select for the given C0 register
98  *
99  * @return ERROR_OK on Sucess, ERROR_FAIL otherwise
100  */
101 int mips32_cp0_write(struct mips_ejtag *ejtag_info,
102                 uint32_t val, uint32_t cp0_reg, uint32_t cp0_sel);
103
104 #endif