DEBUG_F042F6P6 - debug tool for STM32F042F6P6

Users » bieleluk » Code » DEBUG_F042F6P6

debug tool for STM32F042F6P6

Debug.h@15:a9db6d4c2a8f, 2019-04-18 (annotated)

Committer:: bieleluk
Date:: Thu Apr 18 10:41:55 2019 +0000
Revision:: 15:a9db6d4c2a8f
Parent:: 14:5a3b0cabbcd4
Child:: 16:e232e16e4f46

Who changed what in which revision?

User	Revision	Line number	New contents of line
bieleluk	12:5e618e97cb24	1	#pragma once
bieleluk	12:5e618e97cb24	2
bieleluk	12:5e618e97cb24	3	// include files
bieleluk	12:5e618e97cb24	4	//------------------------------------------------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	5	#include "mbed.h"
bieleluk	12:5e618e97cb24	6
bieleluk	12:5e618e97cb24	7	// macros
bieleluk	12:5e618e97cb24	8	//------------------------------------------------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	9	#define name(var) #var
bieleluk	12:5e618e97cb24	10
bieleluk	12:5e618e97cb24	11
bieleluk	12:5e618e97cb24	12	// assembly functions
bieleluk	12:5e618e97cb24	13	//------------------------------------------------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	14	extern "C" int check_1_bit(uint32_t gpiox, uint32_t offset, uint32_t pin);
bieleluk	12:5e618e97cb24	15	extern "C" int check_2_bit(uint32_t gpiox, uint32_t offset, uint32_t pin);
bieleluk	12:5e618e97cb24	16	extern "C" int check_alternative_mode(uint32_t gpiox, uint32_t offset, uint32_t pin);
bieleluk	12:5e618e97cb24	17	extern "C" int read_word(uint32_t address, uint32_t offset);
bieleluk	12:5e618e97cb24	18
bieleluk	12:5e618e97cb24	19	// structs
bieleluk	12:5e618e97cb24	20	//------------------------------------------------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	21	typedef struct Pin {
bieleluk	12:5e618e97cb24	22	char port;
bieleluk	12:5e618e97cb24	23	int number;
bieleluk	12:5e618e97cb24	24	} pin_t;
bieleluk	12:5e618e97cb24	25
bieleluk	12:5e618e97cb24	26
bieleluk	12:5e618e97cb24	27	/** Debug_complete class.
bieleluk	15:a9db6d4c2a8f	28	* Class for stepping programme and printing actual position and complete configuration of certain peripherals.
bieleluk	15:a9db6d4c2a8f	29	* Functions printf, putc and getc are also defined in the class.
bieleluk	15:a9db6d4c2a8f	30	* Example program:
bieleluk	12:5e618e97cb24	31	* @code
bieleluk	12:5e618e97cb24	32	* // ----------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	33	* // Author: Lukas Bielesch
bieleluk	12:5e618e97cb24	34	* // Department of Measurement, Czech technical university in Prague, Czech Republic
bieleluk	12:5e618e97cb24	35	* // Date of publication: 15. Apr 2019
bieleluk	12:5e618e97cb24	36	* // ----------------------------------------------------------------------------
bieleluk	14:5a3b0cabbcd4	37	* #include "Debug.h"
bieleluk	12:5e618e97cb24	38	* AnalogIn analog(PA_5);
bieleluk	12:5e618e97cb24	39	* PwmOut pwm(PA_6);
bieleluk	12:5e618e97cb24	40	* DigitalOut out(PA_4);
bieleluk	12:5e618e97cb24	41	* Debug_complete pc(PA_2, PA_3, 115200);
bieleluk	12:5e618e97cb24	42	*
bieleluk	12:5e618e97cb24	43	* int main(){
bieleluk	12:5e618e97cb24	44	* out = 1;
bieleluk	12:5e618e97cb24	45	* pc.breakpoint(__LINE__);
bieleluk	12:5e618e97cb24	46	* pwm = 0.5;
bieleluk	12:5e618e97cb24	47	* pwm.period(1);
bieleluk	12:5e618e97cb24	48	* while(1){
bieleluk	12:5e618e97cb24	49	* pc.breakpoint(__LINE__);
bieleluk	12:5e618e97cb24	50	* wait(1);
bieleluk	12:5e618e97cb24	51	* pc.breakpoint();
bieleluk	12:5e618e97cb24	52	* pc.printf("value of adc is %f*VDD\n\r",analog.read());
bieleluk	13:3d959f23fd8f	53	* pc.print_reg(0x48000000,0x0);
bieleluk	12:5e618e97cb24	54	* }
bieleluk	12:5e618e97cb24	55	* }
bieleluk	12:5e618e97cb24	56	* @endcode
bieleluk	12:5e618e97cb24	57	*/
bieleluk	12:5e618e97cb24	58	class Debug_complete {
bieleluk	12:5e618e97cb24	59	public:
bieleluk	12:5e618e97cb24	60
bieleluk	12:5e618e97cb24	61	/** Create object of class Debug_complete
bieleluk	12:5e618e97cb24	62	* @param tx_pin TX pin of serial port of the board
bieleluk	12:5e618e97cb24	63	* @param rx_pin RX pin of serial port of the board
bieleluk	12:5e618e97cb24	64	* @param baudrate desired baudrate value of serial port
bieleluk	12:5e618e97cb24	65	*/
bieleluk	12:5e618e97cb24	66	Debug_complete(PinName tx_pin, PinName rx_pin, int baudrate = 115200);
bieleluk	12:5e618e97cb24	67
bieleluk	12:5e618e97cb24	68	/** Perform one breakpoint
bieleluk	12:5e618e97cb24	69	* @param line_number line number of the breakpoint
bieleluk	12:5e618e97cb24	70	*/
bieleluk	12:5e618e97cb24	71	void breakpoint(int line_number = -1);
bieleluk	12:5e618e97cb24	72
bieleluk	12:5e618e97cb24	73
bieleluk	12:5e618e97cb24	74	/** Print one 32-bit word from memory from address shifted by offset
bieleluk	12:5e618e97cb24	75	* @param address
bieleluk	12:5e618e97cb24	76	* @param offset
bieleluk	12:5e618e97cb24	77	*/
bieleluk	12:5e618e97cb24	78	void print_reg(uint32_t address, uint32_t offset = 0);
bieleluk	12:5e618e97cb24	79
bieleluk	12:5e618e97cb24	80	/** Print formatted string to debug serial port
bieleluk	12:5e618e97cb24	81	* @param string
bieleluk	12:5e618e97cb24	82	* @param format (optional)
bieleluk	12:5e618e97cb24	83	* @returns total number of printed characters or negative value if an output error or an encoding error
bieleluk	12:5e618e97cb24	84	*/
bieleluk	12:5e618e97cb24	85	int printf(const char* format, ...);
bieleluk	12:5e618e97cb24	86
bieleluk	12:5e618e97cb24	87	/** Print one character to debug serial port
bieleluk	12:5e618e97cb24	88	* @param character
bieleluk	12:5e618e97cb24	89	* @returns character written as an unsigned char cast to an int
bieleluk	12:5e618e97cb24	90	*/
bieleluk	12:5e618e97cb24	91	int putc(int character);
bieleluk	12:5e618e97cb24	92
bieleluk	12:5e618e97cb24	93	/** Read one character from debug serial port
bieleluk	12:5e618e97cb24	94	* @returns character written as an unsigned char cast to an int
bieleluk	12:5e618e97cb24	95	*/
bieleluk	12:5e618e97cb24	96	int getc();
bieleluk	12:5e618e97cb24	97
bieleluk	12:5e618e97cb24	98
bieleluk	12:5e618e97cb24	99
bieleluk	12:5e618e97cb24	100	private:
bieleluk	12:5e618e97cb24	101	// objects
bieleluk	12:5e618e97cb24	102	Serial pc; //debug serial device
bieleluk	12:5e618e97cb24	103	// variables
bieleluk	12:5e618e97cb24	104	int breakpoint_count; //stores number of the current breakpoint
bieleluk	12:5e618e97cb24	105	//functions
bieleluk	12:5e618e97cb24	106	// print alternate function of pin
bieleluk	12:5e618e97cb24	107	void print_af_mode( char portx, int pin_number, int af_mode);
bieleluk	12:5e618e97cb24	108	// show configuration of pin
bieleluk	12:5e618e97cb24	109	void show_pin_config(pin_t pin);
bieleluk	12:5e618e97cb24	110	// print configuration of timer
bieleluk	12:5e618e97cb24	111	void show_tim_config(int timer);
bieleluk	12:5e618e97cb24	112	// print configuration of pin in pwm output mode
bieleluk	12:5e618e97cb24	113	void show_pwm_config(int timer, int channel);
bieleluk	12:5e618e97cb24	114	// print configuration of pin in analog input mode
bieleluk	12:5e618e97cb24	115	void show_analog_config(int channel);
bieleluk	12:5e618e97cb24	116	// print configuration of adc1 converter
bieleluk	12:5e618e97cb24	117	void show_adc1_config();
bieleluk	12:5e618e97cb24	118	//print configuration of board's clock
bieleluk	12:5e618e97cb24	119	void show_clk_config();
bieleluk	12:5e618e97cb24	120	// clear screen from m line up to n line
bieleluk	12:5e618e97cb24	121	void clear_from_n_up_to_m(int m, int n);
bieleluk	12:5e618e97cb24	122	//initialization function
bieleluk	12:5e618e97cb24	123	void init();
bieleluk	12:5e618e97cb24	124	};
bieleluk	12:5e618e97cb24	125
bieleluk	12:5e618e97cb24	126	/** Debug_serial class.
bieleluk	15:a9db6d4c2a8f	127	* Class for stepping and printing for actual position of the running programme with optional print of one variable (int, float, char or char*).
bieleluk	15:a9db6d4c2a8f	128	* Functions printf, putc and getc are also defined in the class.
bieleluk	12:5e618e97cb24	129	*
bieleluk	15:a9db6d4c2a8f	130	* Example program:
bieleluk	12:5e618e97cb24	131	* @code
bieleluk	12:5e618e97cb24	132	* // ----------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	133	* // Author: Lukas Bielesch
bieleluk	12:5e618e97cb24	134	* // Department of Measurement, Czech technical university in Prague, Czech Republic
bieleluk	12:5e618e97cb24	135	* // Date of publication: 15. Apr 2019
bieleluk	12:5e618e97cb24	136	* // ----------------------------------------------------------------------------
bieleluk	14:5a3b0cabbcd4	137	* #include "Debug.h"
bieleluk	12:5e618e97cb24	138	* AnalogIn analog(PA_5);
bieleluk	12:5e618e97cb24	139	* PwmOut pwm(PA_6);
bieleluk	12:5e618e97cb24	140	* DigitalOut out(PA_4);
bieleluk	15:a9db6d4c2a8f	141	* Debug_serial pc(PA_2, PA_3, 115200); //
bieleluk	12:5e618e97cb24	142	*
bieleluk	12:5e618e97cb24	143	* int main(){
bieleluk	12:5e618e97cb24	144	* int var = 0;
bieleluk	12:5e618e97cb24	145	* char character;
bieleluk	12:5e618e97cb24	146	* out = 1;
bieleluk	12:5e618e97cb24	147	* float pi = 3.14159265359;
bieleluk	12:5e618e97cb24	148	* pc.breakpoint(__LINE__,name(pi),pi);
bieleluk	12:5e618e97cb24	149	* char* arr = "this is string";
bieleluk	12:5e618e97cb24	150	* pc.breakpoint(__LINE__,name(arr),arr);
bieleluk	12:5e618e97cb24	151	* pwm = 0.5;
bieleluk	12:5e618e97cb24	152	* pwm.period(1);
bieleluk	12:5e618e97cb24	153	* while(1){
bieleluk	12:5e618e97cb24	154	* pc.breakpoint(__LINE__,name(var),var);
bieleluk	12:5e618e97cb24	155	* pc.printf("insert character\n\r");
bieleluk	12:5e618e97cb24	156	* character = pc.getc();
bieleluk	12:5e618e97cb24	157	* pc.printf("you have inserted %c\n\r",character);
bieleluk	12:5e618e97cb24	158	* var++;
bieleluk	12:5e618e97cb24	159	* wait(1);
bieleluk	12:5e618e97cb24	160	* }
bieleluk	12:5e618e97cb24	161	* }
bieleluk	12:5e618e97cb24	162	* @endcode
bieleluk	12:5e618e97cb24	163	*/
bieleluk	12:5e618e97cb24	164	//------------------------------------------------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	165	class Debug_serial {
bieleluk	12:5e618e97cb24	166	public:
bieleluk	12:5e618e97cb24	167
bieleluk	12:5e618e97cb24	168	/** Create object of class Debug_serial
bieleluk	12:5e618e97cb24	169	* @param tx_pin TX pin of serial port of the board
bieleluk	12:5e618e97cb24	170	* @param rx_pin RX pin of serial port of the board
bieleluk	12:5e618e97cb24	171	* @param baudrate desired baudrate value of debug serial port
bieleluk	12:5e618e97cb24	172	*/
bieleluk	12:5e618e97cb24	173	Debug_serial(PinName tx_pin, PinName rx_pin, int baudrate = 115200);
bieleluk	12:5e618e97cb24	174
bieleluk	12:5e618e97cb24	175	/** Perform one breakpoint without printing variable
bieleluk	12:5e618e97cb24	176	* @param line_number line number of the breakpoint
bieleluk	12:5e618e97cb24	177	*/
bieleluk	12:5e618e97cb24	178	void breakpoint(int line_number = -1);
bieleluk	12:5e618e97cb24	179
bieleluk	12:5e618e97cb24	180	/** Perform one breakpoint and print variable of type int
bieleluk	12:5e618e97cb24	181	* @param line_number Line number of the breakpoint
bieleluk	12:5e618e97cb24	182	* @param name name of printed variable(max length is 19)
bieleluk	12:5e618e97cb24	183	* @param variable
bieleluk	12:5e618e97cb24	184	*/
bieleluk	12:5e618e97cb24	185	void breakpoint(int line_number, char name[20], int variable);
bieleluk	12:5e618e97cb24	186
bieleluk	12:5e618e97cb24	187	/** Perform one breakpoint and print variable of type char
bieleluk	12:5e618e97cb24	188	* @param line_number Line number of the breakpoint
bieleluk	12:5e618e97cb24	189	* @param name name of printed variable(max length is 19)
bieleluk	12:5e618e97cb24	190	* @param variable
bieleluk	12:5e618e97cb24	191	*/
bieleluk	12:5e618e97cb24	192	void breakpoint(int line_number, char name[20], char variable);
bieleluk	12:5e618e97cb24	193
bieleluk	12:5e618e97cb24	194	/** Perform one breakpoint and print variable of type string
bieleluk	12:5e618e97cb24	195	* @param line_number Line number of the breakpoint
bieleluk	12:5e618e97cb24	196	* @param name name of printed variable(max length is 19)
bieleluk	12:5e618e97cb24	197	* @param variable
bieleluk	12:5e618e97cb24	198	*/
bieleluk	12:5e618e97cb24	199	void breakpoint(int line_number, char name[20], char * variable);
bieleluk	12:5e618e97cb24	200
bieleluk	12:5e618e97cb24	201	/** Perform one breakpoint and print variable of type float
bieleluk	12:5e618e97cb24	202	* @param line_number Line number of the breakpoint
bieleluk	12:5e618e97cb24	203	* @param name name of printed variable(max length is 19)
bieleluk	12:5e618e97cb24	204	* @param variable
bieleluk	12:5e618e97cb24	205	*/
bieleluk	12:5e618e97cb24	206	void breakpoint(int line_number, char name[20], float variable);
bieleluk	12:5e618e97cb24	207
bieleluk	12:5e618e97cb24	208	/** Print formatted string to debug serial port
bieleluk	12:5e618e97cb24	209	* @param string
bieleluk	12:5e618e97cb24	210	* @param format (optional)
bieleluk	12:5e618e97cb24	211	* @returns total number of printed characters or negative value if an output error or an encoding error
bieleluk	12:5e618e97cb24	212	*/
bieleluk	12:5e618e97cb24	213	int printf(const char* format, ...);
bieleluk	12:5e618e97cb24	214
bieleluk	12:5e618e97cb24	215	/** Print one character to debug serial port
bieleluk	12:5e618e97cb24	216	* @param character
bieleluk	12:5e618e97cb24	217	* @returns character written as an unsigned char cast to an int
bieleluk	12:5e618e97cb24	218	*/
bieleluk	12:5e618e97cb24	219	int putc(int character);
bieleluk	12:5e618e97cb24	220
bieleluk	12:5e618e97cb24	221	/** Read one character from debug serial port
bieleluk	12:5e618e97cb24	222	* @returns character written as an unsigned char cast to an int
bieleluk	12:5e618e97cb24	223	*/
bieleluk	12:5e618e97cb24	224	int getc();
bieleluk	12:5e618e97cb24	225	private:
bieleluk	12:5e618e97cb24	226	int break_line[3]; //store number of lines of three previous breakpoints
bieleluk	12:5e618e97cb24	227	char var[3][50]; //store variables of three previous breakpoints
bieleluk	12:5e618e97cb24	228
bieleluk	12:5e618e97cb24	229	protected:
bieleluk	12:5e618e97cb24	230	// objects:
bieleluk	12:5e618e97cb24	231	Serial pc; //debug serial device
bieleluk	12:5e618e97cb24	232	// variables:
bieleluk	12:5e618e97cb24	233	int breakpoint_count; //stores number of the current breakpoint
bieleluk	12:5e618e97cb24	234	// functions
bieleluk	12:5e618e97cb24	235	// initialization function
bieleluk	12:5e618e97cb24	236	void init();
bieleluk	12:5e618e97cb24	237	// print 3 last breakpoints
bieleluk	12:5e618e97cb24	238	void print_3_breaks(int line_number);
bieleluk	12:5e618e97cb24	239	// print one breakpoint
bieleluk	12:5e618e97cb24	240	void print_one_break(int n);
bieleluk	12:5e618e97cb24	241	// clear screen from m line up to n line
bieleluk	12:5e618e97cb24	242	void clear_from_n_up_to_m(int m, int n);
bieleluk	12:5e618e97cb24	243	};
bieleluk	12:5e618e97cb24	244
bieleluk	12:5e618e97cb24	245
bieleluk	12:5e618e97cb24	246
bieleluk	12:5e618e97cb24	247
bieleluk	12:5e618e97cb24	248	/** Debug_led class.
bieleluk	15:a9db6d4c2a8f	249	* Class for stepping the program with debug LED and button, that is connected to GND(default) or VCC.
bieleluk	12:5e618e97cb24	250	*
bieleluk	15:a9db6d4c2a8f	251	* Example program:
bieleluk	12:5e618e97cb24	252	* @code
bieleluk	12:5e618e97cb24	253	* // ----------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	254	* // Author: Lukas Bielesch
bieleluk	12:5e618e97cb24	255	* // Department of Measurement, Czech technical university in Prague, Czech Republic
bieleluk	12:5e618e97cb24	256	* // Date of publication: 15. Apr 2019
bieleluk	12:5e618e97cb24	257	* // ----------------------------------------------------------------------------
bieleluk	14:5a3b0cabbcd4	258	* #include "Debug.h"
bieleluk	12:5e618e97cb24	259	* AnalogIn analog(PA_5);
bieleluk	12:5e618e97cb24	260	* PwmOut pwm(PA_6);
bieleluk	12:5e618e97cb24	261	* DigitalOut out(PA_4);
bieleluk	15:a9db6d4c2a8f	262	* Debug_led deb(PA_5, PA_6, "BUTTON_VDD"); //debug led on PA5, debug button connected to VDD on PA6
bieleluk	12:5e618e97cb24	263	* int main(){
bieleluk	12:5e618e97cb24	264	*
bieleluk	12:5e618e97cb24	265	* out = 1;
bieleluk	12:5e618e97cb24	266	* deb.breakpoint(1);
bieleluk	12:5e618e97cb24	267	* pwm = 0.5;
bieleluk	12:5e618e97cb24	268	* pwm.period(1);
bieleluk	12:5e618e97cb24	269	* deb.breakpoint(2);
bieleluk	12:5e618e97cb24	270	*
bieleluk	12:5e618e97cb24	271	* while(1){
bieleluk	12:5e618e97cb24	272	* deb.breakpoint();
bieleluk	12:5e618e97cb24	273	* pwm = pwm + 0.1;
bieleluk	12:5e618e97cb24	274	* wait(2);
bieleluk	12:5e618e97cb24	275	* }
bieleluk	12:5e618e97cb24	276	* }
bieleluk	12:5e618e97cb24	277	* @endcode
bieleluk	12:5e618e97cb24	278	*/
bieleluk	12:5e618e97cb24	279	// class Debug_led
bieleluk	12:5e618e97cb24	280	//------------------------------------------------------------------------------------------------------------------
bieleluk	12:5e618e97cb24	281	class Debug_led {
bieleluk	12:5e618e97cb24	282	public:
bieleluk	12:5e618e97cb24	283
bieleluk	12:5e618e97cb24	284	/** Create object of class Debug_led
bieleluk	12:5e618e97cb24	285	* @param led_pin pin of of debug led
bieleluk	12:5e618e97cb24	286	* @param button_pin pin of of debug button
bieleluk	12:5e618e97cb24	287	* @param mode mode of button connection("BUTTON_GND", "BUTTON_VCC", "BUTTON_VDD")
bieleluk	12:5e618e97cb24	288	*/
bieleluk	12:5e618e97cb24	289	Debug_led(PinName led_pin, PinName button_pin, char mode[11] = "BUTTON_GND");
bieleluk	12:5e618e97cb24	290
bieleluk	12:5e618e97cb24	291	/** Perform one breakpoint
bieleluk	12:5e618e97cb24	292	* @param number number of flashes of LED during the breakpoint(optional)
bieleluk	12:5e618e97cb24	293	*/
bieleluk	12:5e618e97cb24	294	void breakpoint(int number = -1);
bieleluk	12:5e618e97cb24	295
bieleluk	12:5e618e97cb24	296	private:
bieleluk	12:5e618e97cb24	297	// objects
bieleluk	12:5e618e97cb24	298	DigitalOut led; //debug led
bieleluk	12:5e618e97cb24	299	InterruptIn button; //debug button
bieleluk	12:5e618e97cb24	300	// variables
bieleluk	12:5e618e97cb24	301	int button_mode; //mode of button 1->pullupt, 0->pulldown
bieleluk	12:5e618e97cb24	302	volatile bool end_breakpoint;
bieleluk	12:5e618e97cb24	303	int number_of_breakpoints;
bieleluk	12:5e618e97cb24	304
bieleluk	12:5e618e97cb24	305	/** Initialization */
bieleluk	12:5e618e97cb24	306	void init(char mode[11]);
bieleluk	12:5e618e97cb24	307
bieleluk	12:5e618e97cb24	308	/** Blinks the debug led n-times with blink period wait_time_ms */
bieleluk	12:5e618e97cb24	309	void flash_n_times(int wait_time_ms, int n);
bieleluk	12:5e618e97cb24	310
bieleluk	12:5e618e97cb24	311	/** end the break after the button is pushed */
bieleluk	12:5e618e97cb24	312	void end_break();
bieleluk	12:5e618e97cb24	313
bieleluk	12:5e618e97cb24	314
bieleluk	12:5e618e97cb24	315	};

Repository toolbox

Export to desktop IDE

Repository details

Type:	Library
Created:	16 Apr 2019
Imports:	14
Forks:	0
Commits:	28
Dependents:	0
Dependencies:	0
Followers:	0

Debug.h@15:a9db6d4c2a8f, 2019-04-18 (annotated)

Who changed what in which revision?

Repository toolbox

Repository details

Important Information for this Arm website

Access Warning