mirror of https://github.com/ArduPilot/ardupilot
125 lines
4.3 KiB
C
125 lines
4.3 KiB
C
/******************************************************************************
|
|
* The MIT License
|
|
*
|
|
* Copyright (c) 2011 LeafLabs, LLC.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person
|
|
* obtaining a copy of this software and associated documentation
|
|
* files (the "Software"), to deal in the Software without
|
|
* restriction, including without limitation the rights to use, copy,
|
|
* modify, merge, publish, distribute, sublicense, and/or sell copies
|
|
* of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be
|
|
* included in all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
|
|
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
|
|
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
* SOFTWARE.
|
|
*****************************************************************************/
|
|
|
|
/**
|
|
* @file bitband.h
|
|
*
|
|
* @brief Bit-banding utility functions
|
|
*/
|
|
#ifndef _BITBAND_H_
|
|
#define _BITBAND_H_
|
|
|
|
#include "hal_types.h"
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
static inline volatile uint32_t* __bb_addr(volatile void*,
|
|
uint32_t,
|
|
uint32_t,
|
|
uint32_t);
|
|
|
|
/**
|
|
* @brief Obtain a pointer to the bit-band address corresponding to a
|
|
* bit in a volatile SRAM address.
|
|
* @param address Address in the bit-banded SRAM region
|
|
* @param bit Bit in address to bit-band
|
|
*/
|
|
static inline volatile uint32_t* bb_sramp(volatile void *address, uint32_t bit) {
|
|
return __bb_addr(address, bit, SRAM1_BB_BASE, SRAM_BASE);
|
|
}
|
|
|
|
/**
|
|
* @brief Get a bit from an address in the SRAM bit-band region.
|
|
* @param address Address in the SRAM bit-band region to read from
|
|
* @param bit Bit in address to read
|
|
* @return bit's value in address.
|
|
*/
|
|
static inline uint8_t bb_sram_get_bit(volatile void *address, uint32_t bit) {
|
|
return *bb_sramp(address, bit);
|
|
}
|
|
|
|
/**
|
|
* @brief Set a bit in an address in the SRAM bit-band region.
|
|
* @param address Address in the SRAM bit-band region to write to
|
|
* @param bit Bit in address to write to
|
|
* @param val Value to write for bit, either 0 or 1.
|
|
*/
|
|
static inline void bb_sram_set_bit(volatile void *address,
|
|
uint32_t bit,
|
|
uint8_t val) {
|
|
*bb_sramp(address, bit) = val;
|
|
}
|
|
|
|
/**
|
|
* @brief Obtain a pointer to the bit-band address corresponding to a
|
|
* bit in a peripheral address.
|
|
* @param address Address in the bit-banded peripheral region
|
|
* @param bit Bit in address to bit-band
|
|
*/
|
|
static inline volatile uint32_t* bb_perip(volatile void *address, uint32_t bit) {
|
|
return __bb_addr(address, bit, PERIPH_BB_BASE, PERIPH_BASE);
|
|
}
|
|
|
|
/**
|
|
* @brief Get a bit from an address in the peripheral bit-band region.
|
|
* @param address Address in the peripheral bit-band region to read from
|
|
* @param bit Bit in address to read
|
|
* @return bit's value in address.
|
|
*/
|
|
static inline uint8_t bb_peri_get_bit(volatile void *address, uint32_t bit) {
|
|
return *bb_perip(address, bit);
|
|
}
|
|
|
|
/**
|
|
* @brief Set a bit in an address in the peripheral bit-band region.
|
|
* @param address Address in the peripheral bit-band region to write to
|
|
* @param bit Bit in address to write to
|
|
* @param val Value to write for bit, either 0 or 1.
|
|
*/
|
|
static inline void bb_peri_set_bit(volatile void *address,
|
|
uint32_t bit,
|
|
uint8_t val) {
|
|
*bb_perip(address, bit) = val;
|
|
}
|
|
|
|
static inline volatile uint32_t* __bb_addr(volatile void *address,
|
|
uint32_t bit,
|
|
uint32_t bb_base,
|
|
uint32_t bb_ref) {
|
|
return (volatile uint32_t*)(bb_base + ((uint32_t)address - bb_ref) * 32 +
|
|
bit * 4);
|
|
}
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
|
|
#endif /* _BITBAND_H_ */
|