2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 2002-2008 Sam Leffler, Errno Consulting
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer,
12 * without modification.
13 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
14 * similar to the "NO WARRANTY" disclaimer below ("Disclaimer") and any
15 * redistribution must be conditioned upon including a substantially
16 * similar Disclaimer requirement for further binary redistribution.
19 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 * LIMITED TO, THE IMPLIED WARRANTIES OF NONINFRINGEMENT, MERCHANTIBILITY
22 * AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
23 * THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY,
24 * OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
27 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
29 * THE POSSIBILITY OF SUCH DAMAGES.
33 #ifndef _ATH_AH_OSDEP_H_
34 #define _ATH_AH_OSDEP_H_
36 * Atheros Hardware Access Layer (HAL) OS Dependent Definitions.
38 #include <sys/cdefs.h>
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/endian.h>
42 #include <sys/linker_set.h>
44 #include <machine/bus.h>
47 * Bus i/o type definitions.
49 typedef void *HAL_SOFTC;
50 typedef bus_space_tag_t HAL_BUS_TAG;
51 typedef bus_space_handle_t HAL_BUS_HANDLE;
54 * Although the underlying hardware may support 64 bit DMA, the
55 * current Atheros hardware only supports 32 bit addressing.
57 typedef uint32_t HAL_DMA_ADDR;
60 * Linker set writearounds for chip and RF backend registration.
62 #define OS_DATA_SET(set, item) DATA_SET(set, item)
63 #define OS_SET_DECLARE(set, ptype) SET_DECLARE(set, ptype)
64 #define OS_SET_FOREACH(pvar, set) SET_FOREACH(pvar, set)
67 * Delay n microseconds.
69 #define OS_DELAY(_n) DELAY(_n)
71 #define OS_INLINE __inline
72 #define OS_MEMZERO(_a, _n) bzero((_a), (_n))
73 #define OS_MEMCPY(_d, _s, _n) memcpy(_d,_s,_n)
74 #define OS_MEMCMP(_a, _b, _l) memcmp((_a), (_b), (_l))
76 #define abs(_a) __builtin_abs(_a)
81 * The hardware registers are native little-endian byte order.
82 * Big-endian hosts are handled by enabling hardware byte-swap
83 * of register reads and writes at reset. But the PCI clock
84 * domain registers are not byte swapped! Thus, on big-endian
85 * platforms we have to explicitly byte-swap those registers.
86 * OS_REG_UNSWAPPED identifies the registers that need special handling.
88 * This is not currently used by the FreeBSD HAL osdep code; the HAL
89 * currently does not configure hardware byteswapping for register space
90 * accesses and instead does it through the FreeBSD bus space code.
92 #if _BYTE_ORDER == _BIG_ENDIAN
93 #define OS_REG_UNSWAPPED(_reg) \
94 (((_reg) >= 0x4000 && (_reg) < 0x5000) || \
95 ((_reg) >= 0x7000 && (_reg) < 0x8000))
96 #else /* _BYTE_ORDER == _LITTLE_ENDIAN */
97 #define OS_REG_UNSWAPPED(_reg) (0)
98 #endif /* _BYTE_ORDER */
101 * For USB/SDIO support (where access latencies are quite high);
102 * some write accesses may be buffered and then flushed when
103 * either a read is done, or an explicit flush is done.
105 * These are simply placeholders for now.
107 #define OS_REG_WRITE_BUFFER_ENABLE(_ah) \
109 #define OS_REG_WRITE_BUFFER_DISABLE(_ah) \
111 #define OS_REG_WRITE_BUFFER_FLUSH(_ah) \
115 * Read and write barriers. Some platforms require more strongly ordered
116 * operations and unfortunately most of the HAL is written assuming everything
117 * is either an x86 or the bus layer will do the barriers for you.
119 * Read barriers should occur before each read, and write barriers
120 * occur after each write.
122 * Later on for SDIO/USB parts we will methodize this and make them no-ops;
123 * register accesses will go via USB commands.
125 #define OS_BUS_BARRIER_READ BUS_SPACE_BARRIER_READ
126 #define OS_BUS_BARRIER_WRITE BUS_SPACE_BARRIER_WRITE
127 #define OS_BUS_BARRIER_RW \
128 (BUS_SPACE_BARRIER_READ | BUS_SPACE_BARRIER_WRITE)
129 #define OS_BUS_BARRIER(_ah, _start, _len, _t) \
130 bus_space_barrier((bus_space_tag_t)(_ah)->ah_st, \
131 (bus_space_handle_t)(_ah)->ah_sh, (_start), (_len), (_t))
132 #define OS_BUS_BARRIER_REG(_ah, _reg, _t) \
133 OS_BUS_BARRIER((_ah), (_reg), 4, (_t))
136 * Register read/write operations are handled through
137 * platform-dependent routines.
139 #define OS_REG_WRITE(_ah, _reg, _val) ath_hal_reg_write(_ah, _reg, _val)
140 #define OS_REG_READ(_ah, _reg) ath_hal_reg_read(_ah, _reg)
142 extern void ath_hal_reg_write(struct ath_hal *ah, u_int reg, u_int32_t val);
143 extern u_int32_t ath_hal_reg_read(struct ath_hal *ah, u_int reg);
146 extern void OS_MARK(struct ath_hal *, u_int id, u_int32_t value);
148 #define OS_MARK(_ah, _id, _v)
151 #endif /* _ATH_AH_OSDEP_H_ */