include/mmio.h

   1 /*
   2  * MMIO helper library header file.
   3  *
   4  * Copyright (C) 2019 Texas Instruments Incorporated - http://www.ti.com/
   5  *      Lokesh Vutla <lokeshvutla@ti.com>
   6  *      Nishanth Menon <nm@ti.com>
   7  *
   8  *  Redistribution and use in source and binary forms, with or without
   9  *  modification, are permitted provided that the following conditions
  10  *  are met:
  11  *
  12  *    Redistributions of source code must retain the above copyright
  13  *    notice, this list of conditions and the following disclaimer.
  14  *
  15  *    Redistributions in binary form must reproduce the above copyright
  16  *    notice, this list of conditions and the following disclaimer in the
  17  *    documentation and/or other materials provided with the
  18  *    distribution.
  19  *
  20  *    Neither the name of Texas Instruments Incorporated nor the names of
  21  *    its contributors may be used to endorse or promote products derived
  22  *    from this software without specific prior written permission.
  23  *
  24  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  25  *  "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  26  *  LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  27  *  A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  28  *  OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  29  *  SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  30  *  LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  31  *  DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  32  *  THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  33  *  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  34  *  OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  35  */
  36
  37 #ifndef __MMIO_H
  38 #define __MMIO_H
  39
  40 #include <stdio.h>
  41 #include <stdint.h>
  42 #include <stdarg.h>
  43 #include <stddef.h>
  44 #include <ctype.h>
  45
  46 void mmio_write_8(uintptr_t addr, uint8_t value);
  47
  48 uint8_t mmio_read_8(uintptr_t addr);
  49
  50 void mmio_write_16(uintptr_t addr, uint16_t value);
  51
  52 uint16_t mmio_read_16(uintptr_t addr);
  53
  54 void mmio_write_32(uintptr_t addr, uint32_t value);
  55
  56 uint32_t mmio_read_32(uintptr_t addr);
  57
  58 void mmio_write_64(uintptr_t addr, uint64_t value);
  59
  60 uint64_t mmio_read_64(uintptr_t addr);
  61
  62 static inline void mmio_clrbits_32(uintptr_t addr, uint32_t clear)
  63 {
  64         mmio_write_32(addr, mmio_read_32(addr) & ~clear);
  65 }
  66
  67 static inline void mmio_setbits_32(uintptr_t addr, uint32_t set)
  68 {
  69         mmio_write_32(addr, mmio_read_32(addr) | set);
  70 }
  71
  72 static inline void mmio_clrsetbits_32(uintptr_t addr,
  73                                       uint32_t clear, uint32_t set)
  74 {
  75         mmio_write_32(addr, (mmio_read_32(addr) & ~clear) | set);
  76 }
  77
  78 #endif /* __MMIO_H */