annotate packages/devs/usb/at91/current/src/bitops.h @ 2729:74dbf4c3f2e1 after-copyright-change-20090129

Update all copyright banners to reflect FSF ownership; fix and improve licence text.
author jlarmour
date Thu, 29 Jan 2009 17:47:46 +0000
parents 54308c2d9651
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2184
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
1 #ifndef CYGONCE_USBS_AT91_BITOPS_H
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
2 #define CYGONCE_USBS_AT91_BITOPS_H
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
3
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
4 //==========================================================================
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
5 //
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
6 // bitops.h
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
7 //
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
8 // Hardware Bit manipulation macros for the AT91 USB device
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
9 //
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
10 //==========================================================================
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
11 // ####ECOSGPLCOPYRIGHTBEGIN####
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
12 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
13 // This file is part of eCos, the Embedded Configurable Operating System.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
14 // Copyright (C) 1998, 1999, 2000, 2001, 2002 Free Software Foundation, Inc.
2184
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
15 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
16 // eCos is free software; you can redistribute it and/or modify it under
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
17 // the terms of the GNU General Public License as published by the Free
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
18 // Software Foundation; either version 2 or (at your option) any later
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
19 // version.
2184
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
20 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
21 // eCos is distributed in the hope that it will be useful, but WITHOUT
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
22 // ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
23 // FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
24 // for more details.
2184
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
25 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
26 // You should have received a copy of the GNU General Public License
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
27 // along with eCos; if not, write to the Free Software Foundation, Inc.,
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
28 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2184
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
29 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
30 // As a special exception, if other files instantiate templates or use
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
31 // macros or inline functions from this file, or you compile this file
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
32 // and link it with other works to produce a work based on this file,
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
33 // this file does not by itself cause the resulting work to be covered by
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
34 // the GNU General Public License. However the source code for this file
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
35 // must still be made available in accordance with section (3) of the GNU
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
36 // General Public License v2.
2184
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
37 //
2729
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
38 // This exception does not invalidate any other reasons why a work based
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
39 // on this file might be covered by the GNU General Public License.
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
40 // -------------------------------------------
74dbf4c3f2e1 Update all copyright banners to reflect FSF ownership; fix and improve licence text.
jlarmour
parents: 2184
diff changeset
41 // ####ECOSGPLCOPYRIGHTEND####
2184
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
42 //==========================================================================
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
43 //#####DESCRIPTIONBEGIN####
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
44 //
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
45 // Author(s): Oliver Munz
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
46 // Contributors: bartv
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
47 // Date: 2006-02-22
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
48 //
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
49 //####DESCRIPTIONEND####
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
50 //==========================================================================
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
51
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
52 // Set the given bits in a device register
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
53 #define SET_BITS(_register_, _bits_) \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
54 CYG_MACRO_START \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
55 cyg_uint32 _value_; \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
56 HAL_READ_UINT32(_register_, _value_); \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
57 _value_ |= _bits_; \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
58 HAL_WRITE_UINT32(_register_, _value_); \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
59 CYG_MACRO_END
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
60
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
61 // Clear the given bits in a device register
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
62 #define CLEAR_BITS(_register_, _bits_) \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
63 CYG_MACRO_START \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
64 cyg_uint32 _value_; \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
65 HAL_READ_UINT32(_register_, _value_); \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
66 _value_ &= ~_bits_; \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
67 HAL_WRITE_UINT32(_register_, _value_); \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
68 CYG_MACRO_END
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
69
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
70 #define BITS_ARE_SET(_register_, _bits) \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
71 bits_are_set(_register_, _bits)
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
72
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
73 #define BITS_ARE_CLEARED(_register_, _bits) \
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
74 bits_are_cleared(_register_, _bits)
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
75
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
76 static inline cyg_bool
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
77 bits_are_set (cyg_addrword_t addr, cyg_uint32 bits)
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
78 {
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
79 cyg_uint32 read;
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
80
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
81 HAL_READ_UINT32 (addr, read);
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
82
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
83 return (read & bits) == bits;
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
84 }
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
85
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
86 static inline cyg_bool
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
87 bits_are_cleared (cyg_addrword_t addr, cyg_uint32 bits)
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
88 {
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
89 cyg_uint32 read;
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
90
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
91 HAL_READ_UINT32 (addr, read);
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
92
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
93 return (read | ~bits) == ~bits;
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
94 }
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
95
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
96
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
97 #endif // CYGONCE_USBS_AT91_BITOPS_H
54308c2d9651 AT91 USB device driver by Oliver Munz and Andrew Lunn.
asl
parents:
diff changeset
98