| 1 | /*
|
|---|
| 2 | * Copyright (c) 2017 Ondrej Hlavaty
|
|---|
| 3 | * All rights reserved.
|
|---|
| 4 | *
|
|---|
| 5 | * Redistribution and use in source and binary forms, with or without
|
|---|
| 6 | * modification, are permitted provided that the following conditions
|
|---|
| 7 | * are met:
|
|---|
| 8 | *
|
|---|
| 9 | * - Redistributions of source code must retain the above copyright
|
|---|
| 10 | * notice, this list of conditions and the following disclaimer.
|
|---|
| 11 | * - Redistributions in binary form must reproduce the above copyright
|
|---|
| 12 | * notice, this list of conditions and the following disclaimer in the
|
|---|
| 13 | * documentation and/or other materials provided with the distribution.
|
|---|
| 14 | * - The name of the author may not be used to endorse or promote products
|
|---|
| 15 | * derived from this software without specific prior written permission.
|
|---|
| 16 | *
|
|---|
| 17 | * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|---|
| 18 | * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|---|
| 19 | * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|---|
| 20 | * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|---|
| 21 | * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|---|
| 22 | * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|---|
| 23 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|---|
| 24 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|---|
| 25 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|---|
| 26 | * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|---|
| 27 | */
|
|---|
| 28 |
|
|---|
| 29 | /** @addtogroup drvusbxhci
|
|---|
| 30 | * @{
|
|---|
| 31 | */
|
|---|
| 32 | /** @file
|
|---|
| 33 | * @brief Common macros for HW structures.
|
|---|
| 34 | *
|
|---|
| 35 | * There are a lot of data structures that are defined on bit-basis.
|
|---|
| 36 | * Therefore, we provide macros to define getters and setters.
|
|---|
| 37 | */
|
|---|
| 38 |
|
|---|
| 39 | #ifndef XHCI_COMMON_H
|
|---|
| 40 | #define XHCI_COMMON_H
|
|---|
| 41 |
|
|---|
| 42 | #include <assert.h>
|
|---|
| 43 | #include <bitops.h>
|
|---|
| 44 | #include <ddi.h>
|
|---|
| 45 | #include <byteorder.h>
|
|---|
| 46 |
|
|---|
| 47 | #define host2xhci(size, val) host2uint##size##_t_le((val))
|
|---|
| 48 | #define xhci2host(size, val) uint##size##_t_le2host((val))
|
|---|
| 49 |
|
|---|
| 50 | /**
|
|---|
| 51 | * 4 bytes, little-endian.
|
|---|
| 52 | */
|
|---|
| 53 | typedef ioport32_t xhci_dword_t __attribute__((aligned(4)));
|
|---|
| 54 |
|
|---|
| 55 | /**
|
|---|
| 56 | * 8 bytes, little-endian.
|
|---|
| 57 | */
|
|---|
| 58 | typedef volatile uint64_t xhci_qword_t __attribute__((aligned(8)));
|
|---|
| 59 |
|
|---|
| 60 | #define XHCI_DWORD_EXTRACT(field, hi, lo) (BIT_RANGE_EXTRACT(uint32_t, hi, lo, xhci2host(32, field)))
|
|---|
| 61 |
|
|---|
| 62 | /**
|
|---|
| 63 | * Common base for setters on xhci_dword_t storage.
|
|---|
| 64 | *
|
|---|
| 65 | * Not thread-safe, proper synchronization over this dword must be assured.
|
|---|
| 66 | */
|
|---|
| 67 | static inline void xhci_dword_set_bits(xhci_dword_t *storage, uint32_t value, unsigned hi, unsigned lo)
|
|---|
| 68 | {
|
|---|
| 69 | const uint32_t mask = host2xhci(32, BIT_RANGE(uint32_t, hi, lo));
|
|---|
| 70 | const uint32_t set = host2xhci(32, value << lo);
|
|---|
| 71 | *storage = (*storage & ~mask) | set;
|
|---|
| 72 | }
|
|---|
| 73 |
|
|---|
| 74 | /**
|
|---|
| 75 | * Setter for whole qword.
|
|---|
| 76 | */
|
|---|
| 77 | static inline void xhci_qword_set(xhci_qword_t *storage, uint64_t value)
|
|---|
| 78 | {
|
|---|
| 79 | *storage = host2xhci(64, value);
|
|---|
| 80 | }
|
|---|
| 81 |
|
|---|
| 82 | #endif
|
|---|
| 83 |
|
|---|
| 84 | /**
|
|---|
| 85 | * @}
|
|---|
| 86 | */
|
|---|
