Prusa MINI Firmware overview
macros.h
Go to the documentation of this file.
1 /**
2  * Copyright (C) 2011 Circuits At Home, LTD. All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17  *
18  * Contact information
19  * -------------------
20  *
21  * Circuits At Home, LTD
22  * Web : http://www.circuitsathome.com
23  * e-mail : support@circuitsathome.com
24  */
25 #pragma once
26 
27 #ifndef _usb_h_
28  #error "Never include macros.h directly; include Usb.h instead"
29 #endif
30 
31 ////////////////////////////////////////////////////////////////////////////////
32 // HANDY MACROS
33 ////////////////////////////////////////////////////////////////////////////////
34 
35 #define VALUE_BETWEEN(v,l,h) (((v)>(l)) && ((v)<(h)))
36 #define VALUE_WITHIN(v,l,h) (((v)>=(l)) && ((v)<=(h)))
37 #define output_pgm_message(wa,fp,mp,el) wa = &mp, fp((char *)pgm_read_pointer(wa), el)
38 #define output_if_between(v,l,h,wa,fp,mp,el) if (VALUE_BETWEEN(v,l,h)) output_pgm_message(wa,fp,mp[v-(l+1)],el);
39 
40 #define SWAP(a, b) (((a) ^= (b)), ((b) ^= (a)), ((a) ^= (b)))
41 #ifndef __BYTE_GRABBING_DEFINED__
42 #define __BYTE_GRABBING_DEFINED__ 1
43 #ifdef BROKEN_OPTIMIZER_LITTLE_ENDIAN
44 // Note: Use this if your compiler generates horrible assembler!
45 #define BGRAB0(__usi__) (((uint8_t *)&(__usi__))[0])
46 #define BGRAB1(__usi__) (((uint8_t *)&(__usi__))[1])
47 #define BGRAB2(__usi__) (((uint8_t *)&(__usi__))[2])
48 #define BGRAB3(__usi__) (((uint8_t *)&(__usi__))[3])
49 #define BGRAB4(__usi__) (((uint8_t *)&(__usi__))[4])
50 #define BGRAB5(__usi__) (((uint8_t *)&(__usi__))[5])
51 #define BGRAB6(__usi__) (((uint8_t *)&(__usi__))[6])
52 #define BGRAB7(__usi__) (((uint8_t *)&(__usi__))[7])
53 #else
54 // Note: The cast alone to uint8_t is actually enough.
55 // GCC throws out the "& 0xff", and the size is no different.
56 // Some compilers need it.
57 #define BGRAB0(__usi__) ((uint8_t)((__usi__) & 0xff ))
58 #define BGRAB1(__usi__) ((uint8_t)(((__usi__) >> 8) & 0xff))
59 #define BGRAB2(__usi__) ((uint8_t)(((__usi__) >> 16) & 0xff))
60 #define BGRAB3(__usi__) ((uint8_t)(((__usi__) >> 24) & 0xff))
61 #define BGRAB4(__usi__) ((uint8_t)(((__usi__) >> 32) & 0xff))
62 #define BGRAB5(__usi__) ((uint8_t)(((__usi__) >> 40) & 0xff))
63 #define BGRAB6(__usi__) ((uint8_t)(((__usi__) >> 48) & 0xff))
64 #define BGRAB7(__usi__) ((uint8_t)(((__usi__) >> 56) & 0xff))
65 #endif
66 #define BOVER1(__usi__) ((uint16_t)(__usi__) << 8)
67 #define BOVER2(__usi__) ((uint32_t)(__usi__) << 16)
68 #define BOVER3(__usi__) ((uint32_t)(__usi__) << 24)
69 #define BOVER4(__usi__) ((uint64_t)(__usi__) << 32)
70 #define BOVER5(__usi__) ((uint64_t)(__usi__) << 40)
71 #define BOVER6(__usi__) ((uint64_t)(__usi__) << 48)
72 #define BOVER7(__usi__) ((uint64_t)(__usi__) << 56)
73 
74 // These are the smallest and fastest ways I have found so far in pure C/C++.
75 #define BMAKE16(__usc1__,__usc0__) ((uint16_t)((uint16_t)(__usc0__) | (uint16_t)BOVER1(__usc1__)))
76 #define BMAKE32(__usc3__,__usc2__,__usc1__,__usc0__) ((uint32_t)((uint32_t)(__usc0__) | (uint32_t)BOVER1(__usc1__) | (uint32_t)BOVER2(__usc2__) | (uint32_t)BOVER3(__usc3__)))
77 #define BMAKE64(__usc7__,__usc6__,__usc5__,__usc4__,__usc3__,__usc2__,__usc1__,__usc0__) ((uint64_t)((uint64_t)__usc0__ | (uint64_t)BOVER1(__usc1__) | (uint64_t)BOVER2(__usc2__) | (uint64_t)BOVER3(__usc3__) | (uint64_t)BOVER4(__usc4__) | (uint64_t)BOVER5(__usc5__) | (uint64_t)BOVER6(__usc6__) | (uint64_t)BOVER1(__usc7__)))
78 #endif
79 
80 /*
81  * Debug macros: Strings are stored in progmem (flash) instead of RAM.
82  */
83 #define USBTRACE(s) (Notify(PSTR(s), 0x80))
84 #define USBTRACE1(s,l) (Notify(PSTR(s), l))
85 #define USBTRACE2(s,r) (Notify(PSTR(s), 0x80), D_PrintHex((r), 0x80), Notify(PSTR("\r\n"), 0x80))
86 #define USBTRACE3(s,r,l) (Notify(PSTR(s), l), D_PrintHex((r), l), Notify(PSTR("\r\n"), l))