123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606 |
- /******************************************************************************
- ******************************************************************************/
- #ifndef __BME_H
- #define __BME_H
- #ifdef __cplusplus
- extern "C" {
- #endif
- /******************************************************************************
- * BME operation code
- *
- *//*! @addtogroup BME_OPCode
- * @{
- *******************************************************************************/
- #define BME_OPCODE_AND 1 /*!< AND opcode */
- #define BME_OPCODE_OR 2 /*!< OR opcode */
- #define BME_OPCODE_XOR 3 /*!< XOR opcode */
- #define BME_OPCODE_BITFIELD 4 /*!< Bit field opcode */
- #define BME_OPCODE_BIT_CLEAR 2 /*!< Bit clear opcode */
- #define BME_OPCODE_BIT_SET 3 /*!< Bit set opcode */
- /*! @} End of BME_OPCode */
- /******************************************************************************
- * BME macro used to generate hardcoded BME addresses
- *
- *//*! @addtogroup BME_Utilities
- * @{
- *******************************************************************************/
- /******************************************************************************
- * macro used to generate hardcoded AND address.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME AND operation addresss (hardcoded 32-bit address).
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_AND(ADDR) (*(volatile uint32_t *)(((uint32_t)ADDR) | (BME_OPCODE_AND<<26)))
- /******************************************************************************
- * macro used to generate hardcoded OR address.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME OR operation addresss (hardcoded 32-bit address).
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_OR(ADDR) (*(volatile uint32_t *)(((uint32_t)ADDR) | (BME_OPCODE_OR<<26)))
- /******************************************************************************
- * macro used to generate hardcoded XOR address.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME XOR operation addresss (hardcoded 32-bit address).
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_XOR(ADDR) (*(volatile uint32_t *)(((uint32_t)ADDR) | (BME_OPCODE_XOR<<26)))
- #if !defined(BME_SANITY_CHECK)
- /*!
- * @brief This is fastest way for BME without sanity check.
- */
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit clear address (LAC1).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bit clear operation addresss (hardcoded 32-bit address).
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
-
- #define BME_BIT_CLEAR(ADDR,bit) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_CLEAR <<26) \
- | ((bit)<<21)))
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit set address (LAS1).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bit set operation addresss (hardcoded 32-bit address).
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_BIT_SET(ADDR,bit) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_SET <<26) \
- | ((bit)<<21)))
- /******************************************************************************
- * macro used to generate hardcoded bit field insert address (BFI).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bitfield insert operation addresss (hardcoded 32-bit address).
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- * @param[in] width bitfield width, 1-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_BITFIELD_INSERT(ADDR,bit,width) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit)<<23) | ((width-1))<<19))
- /******************************************************************************
- * macro used to generate hardcoded bit field extract address (UBFX).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bitfield extract operation addresss (hardcoded 32-bit address).
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- * @param[in] width bitfield width, 1-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_BITFIELD_EXTRACT(ADDR,bit,width) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit)<<23) | ((width-1))<<19))
- #else
- /*!
- * @brief This is slow way for BME as it has sanity check.
- */
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit clear address (LAC1).
- *
- *******************************************************************************/
- #define BME_BIT_CLEAR(ADDR,bit) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_CLEAR <<26) \
- | ((bit & 0x1F)<<21))) /*!< Bit clear operation */
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit set address (LAS1).
- *
- *******************************************************************************/
- #define BME_BIT_SET(ADDR,bit) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_SET <<26) \
- | ((bit & 0x1F)<<21))) /*!< Bit set operation */
- /******************************************************************************
- * macro used to generate hardcoded bit field insert address (BFI).
- *
- *******************************************************************************/
- #define BME_BITFIELD_INSERT(ADDR,bit,width) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit & 0x1F)<<23) | ((width-1) & 0xF)<<19)) /*!< Bitfield insert operation */
- /******************************************************************************
- * macro used to generate hardcoded bit field extract address (UBFX).
- *
- *******************************************************************************/
- #define BME_BITFIELD_EXTRACT(ADDR,bit,width) (*(volatile uint32_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit & 0x1F)<<23) | ((width-1) & 0xF)<<19)) /*!< Bitfield extract operation */
- #endif
- /******************************************************************************
- * The following macros are used to generate hardcoded address for 8-bit operation.
- *
- *******************************************************************************/
- /******************************************************************************
- * macro used to generate hardcoded AND address for 8-bit operation.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME AND operation addresss (hardcoded 32-bit address) for 8-bit data.
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_AND_8b(ADDR) (*(volatile uint8_t *)(((uint32_t)ADDR) | (BME_OPCODE_AND<<26)))
- /******************************************************************************
- * macro used to generate hardcoded OR address.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME OR operation addresss (hardcoded 32-bit address) for 8-bit data.
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_OR_8b(ADDR) (*(volatile uint8_t *)(((uint32_t)ADDR) | (BME_OPCODE_OR<<26)))
- /******************************************************************************
- * macro used to generate hardcoded XOR address.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME XOR operation addresss (hardcoded 32-bit address) for 8-bit data.
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_XOR_8b(ADDR) (*(volatile uint8_t *)(((uint32_t)ADDR) | (BME_OPCODE_XOR<<26)))
- #if !defined(BME_SANITY_CHECK)
- /*!
- * @brief This is fastest way for BME without sanity check.
- */
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit clear address (LAC1).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bit clear operation addresss (hardcoded 32-bit address) for 8-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
-
- #define BME_BIT_CLEAR_8b(ADDR,bit) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_CLEAR <<26) \
- | ((bit)<<21)))
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit set address (LAS1).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bit set operation addresss (hardcoded 32-bit address) for 8-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
-
- #define BME_BIT_SET_8b(ADDR,bit) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_SET <<26) \
- | ((bit)<<21)))
- /******************************************************************************
- * macro used to generate hardcoded bit field insert address (BFI).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bitfield insert operation addresss (hardcoded 32-bit address) for 8-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- * @param[in] width bitfield width, 1-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_BITFIELD_INSERT_8b(ADDR,bit,width) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit)<<23) | ((width-1))<<19))
- /******************************************************************************
- * macro used to generate hardcoded bit field extract address (UBFX).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bitfield extract operation addresss (hardcoded 32-bit address) for 8-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- * @param[in] width bitfield width, 1-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_BITFIELD_EXTRACT_8b(ADDR,bit,width) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit<<23) | ((width-1))<<19))
- #else
- /*!
- * @brief This is slow way for BME as it has sanity check.
- */
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit clear address (LAC1).
- *
- *******************************************************************************/
- #define BME_BIT_CLEAR_8b(ADDR,bit) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_CLEAR <<26) \
- | ((bit & 0x1F)<<21))) /*!< Bit clear operation on 8-bit*/
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit set address (LAS1).
- *
- *******************************************************************************/
- #define BME_BIT_SET_8b(ADDR,bit) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_SET <<26) \
- | ((bit & 0x1F)<<21))) /*!< Bit set operation on 8-bit */
- /******************************************************************************
- * macro used to generate hardcoded bit field insert address (BFI).
- *
- *******************************************************************************/
- #define BME_BITFIELD_INSERT_8b(ADDR,bit,width) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit & 0x1F)<<23) | ((width-1) & 0xF)<<19)) /*!< Bitfield insert operation on 8-bit */
- /******************************************************************************
- * macro used to generate hardcoded bit field extract address (UBFX).
- *
- *******************************************************************************/
- #define BME_BITFIELD_EXTRACT_8b(ADDR,bit,width) (*(volatile uint8_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit & 0x1F)<<23) | ((width-1) & 0xF)<<19)) /*!< Bitfield extract operation on 8-bit*/
- #endif
- /******************************************************************************
- * The following macros are used to generate hardcoded address for 16-bit operation.
- *
- *******************************************************************************/
- /******************************************************************************
- * macro used to generate hardcoded AND address for 16-bit operation.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME AND operation addresss (hardcoded 32-bit address) for 16-bit data.
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_AND_16b(ADDR) (*(volatile uint16_t *)(((uint32_t)ADDR) | (BME_OPCODE_AND<<26)))
- /******************************************************************************
- * macro used to generate hardcoded OR address.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME OR operation addresss (hardcoded 32-bit address) for 16-bit data.
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_OR_16b(ADDR) (*(volatile uint16_t *)(((uint32_t)ADDR) | (BME_OPCODE_OR<<26)))
- /******************************************************************************
- * macro used to generate hardcoded XOR address.
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME XOR operation addresss (hardcoded 32-bit address) for 16-bit data.
- *
- * @param[in] ADDR 32-bit address.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_XOR_16b(ADDR) (*(volatile uint16_t *)(((uint32_t)ADDR) | (BME_OPCODE_XOR<<26)))
- #if !defined(BME_SANITY_CHECK)
- /*!
- * @brief This is fastest way for BME without sanity check.
- */
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit clear address (LAC1).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bit clear operation addresss (hardcoded 32-bit address) for 16-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
-
- #define BME_BIT_CLEAR_16b(ADDR,bit) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_CLEAR <<26) \
- | ((bit)<<21)))
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit set address (LAS1).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bit set operation addresss (hardcoded 32-bit address) for 16-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
-
- #define BME_BIT_SET_16b(ADDR,bit) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_SET <<26) \
- | ((bit)<<21)))
- /******************************************************************************
- * macro used to generate hardcoded bit field insert address (BFI).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bitfield insert operation addresss (hardcoded 32-bit address) for 16-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- * @param[in] width bitfield width, 1-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
-
- #define BME_BITFIELD_INSERT_16b(ADDR,bit,width) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit)<<23) | ((width-1))<<19))
- /******************************************************************************
- * macro used to generate hardcoded bit field extract address (UBFX).
- *
- *******************************************************************************/
- /*****************************************************************************//*!
- *
- * @brief generates BME bitfield extract operation addresss (hardcoded 32-bit address) for 16-bit data.
- *
- * @param[in] ADDR 32-bit address.
- * @param[in] bit bit number, 0-based.
- * @param[in] width bitfield width, 1-based.
- *
- * @return hardcoded 32-bit address.
- *
- * @ Pass/ Fail criteria: none.
- *
- *****************************************************************************/
- #define BME_BITFIELD_EXTRACT_16b(ADDR,bit,width) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit)<<23) | ((width-1))<<19))
- #else
- /*!
- * @brief This is slow way for BME as it has sanity check.
- */
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit clear address (LAC1).
- *
- *******************************************************************************/
- #define BME_BIT_CLEAR_16b(ADDR,bit) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_CLEAR <<26) \
- | ((bit & 0x1F)<<21))) /*!< Bit clear operation on 16-bit*/
- /******************************************************************************
- * macro used to generate hardcoded load 1 bit set address (LAS1).
- *
- *******************************************************************************/
- #define BME_BIT_SET_16b(ADDR,bit) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BIT_SET <<26) \
- | ((bit & 0x1F)<<21))) /*!< Bit set operation on 16-bit */
- /******************************************************************************
- * macro used to generate hardcoded bit field insert address (BFI).
- *
- *******************************************************************************/
- #define BME_BITFIELD_INSERT_16b(ADDR,bit,width) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit & 0x1F)<<23) | ((width-1) & 0xF)<<19)) /*!< Bitfield insert operation on 16-bit */
- /******************************************************************************
- * macro used to generate hardcoded bit field extract address (UBFX).
- *
- *******************************************************************************/
- #define BME_BITFIELD_EXTRACT_16b(ADDR,bit,width) (*(volatile uint16_t *)(((uint32_t)ADDR) \
- | (BME_OPCODE_BITFIELD <<26) \
- | ((bit & 0x1F)<<23) | ((width-1) & 0xF)<<19)) /*!< Bitfield extract operation on 16-bit*/
- #endif
- /*! @} End of BME_Utilities */
- #ifdef __cplusplus
- }
- #endif
- #endif /* __BME_H */
|