summaryrefslogtreecommitdiff
path: root/src/include/region.h
diff options
context:
space:
mode:
authorAaron Durbin <adurbin@chromium.org>2015-09-08 13:34:43 -0500
committerAaron Durbin <adurbin@chromium.org>2015-09-22 21:21:34 +0000
commitdc9f5cd54661e5ba3fffee7af0ba17dde9367b95 (patch)
tree43b5eca98ba0b09390ff9a6d1174c2e0cce94e1b /src/include/region.h
parent4b93a4f47a7457162d1be20eeffe57f81d5cd6af (diff)
coreboot: introduce commonlib
Instead of reaching into src/include and re-writing code allow for cleaner code sharing within coreboot and its utilities. The additional thing needed at this point is for the utilities to provide a printk() declaration within a <console/console.h> file. That way code which uses printk() can than be mapped properly to verbosity of utility parameters. Change-Id: I9e46a279569733336bc0a018aed96bc924c07cdd Signed-off-by: Aaron Durbin <adurbin@chromium.org> Reviewed-on: http://review.coreboot.org/11592 Tested-by: build bot (Jenkins) Reviewed-by: Alexandru Gagniuc <mr.nuke.me@gmail.com>
Diffstat (limited to 'src/include/region.h')
-rw-r--r--src/include/region.h157
1 files changed, 0 insertions, 157 deletions
diff --git a/src/include/region.h b/src/include/region.h
deleted file mode 100644
index 82db854994..0000000000
--- a/src/include/region.h
+++ /dev/null
@@ -1,157 +0,0 @@
-/*
- * This file is part of the coreboot project.
- *
- * Copyright 2015 Google Inc.
- *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; version 2 of the License.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc.
- */
-
-#ifndef _REGION_H_
-#define _REGION_H_
-
-#include <stdint.h>
-#include <stddef.h>
-#include <mem_pool.h>
-
-/*
- * Region support.
- *
- * Regions are intended to abstract away the access mechanisms for blocks of
- * data. This could be SPI, eMMC, or a memory region as the backing store.
- * They are accessed through a region_device. Subregions can be made by
- * chaining together multiple region_devices.
- */
-
-struct region_device;
-
-/*
- * Returns NULL on error otherwise a buffer is returned with the conents of
- * the requested data at offset of size.
- */
-void *rdev_mmap(const struct region_device *rd, size_t offset, size_t size);
-
-/* Unmap a previously mapped area. Returns 0 on success, < 0 on error. */
-int rdev_munmap(const struct region_device *rd, void *mapping);
-
-/*
- * Returns < 0 on error otherwise returns size of data read at provided
- * offset filling in the buffer passed.
- */
-ssize_t rdev_readat(const struct region_device *rd, void *b, size_t offset,
- size_t size);
-
-
-/****************************************
- * Implementation of a region device *
- ****************************************/
-
-/*
- * Create a child region of the parent provided the sub-region is within
- * the parent's region. Returns < 0 on error otherwise 0 on success. Note
- * that the child device only calls through the parent's operations.
- */
-int rdev_chain(struct region_device *child, const struct region_device *parent,
- size_t offset, size_t size);
-
-
-/* A region_device operations. */
-struct region_device_ops {
- void *(*mmap)(const struct region_device *, size_t, size_t);
- int (*munmap)(const struct region_device *, void *);
- ssize_t (*readat)(const struct region_device *, void *, size_t, size_t);
-};
-
-struct region {
- size_t offset;
- size_t size;
-};
-
-struct region_device {
- const struct region_device *root;
- const struct region_device_ops *ops;
- struct region region;
-};
-
-#define REGION_DEV_INIT(ops_, offset_, size_) \
- { \
- .root = NULL, \
- .ops = (ops_), \
- .region = { \
- .offset = (offset_), \
- .size = (size_), \
- }, \
- }
-
-static inline size_t region_offset(const struct region *r)
-{
- return r->offset;
-}
-
-static inline size_t region_sz(const struct region *r)
-{
- return r->size;
-}
-
-static inline size_t region_device_sz(const struct region_device *rdev)
-{
- return region_sz(&rdev->region);
-}
-
-static inline size_t region_device_offset(const struct region_device *rdev)
-{
- return region_offset(&rdev->region);
-}
-
-/* Memory map entire region device. Same semantics as rdev_mmap() above. */
-static inline void *rdev_mmap_full(const struct region_device *rd)
-{
- return rdev_mmap(rd, 0, region_device_sz(rd));
-}
-
-struct mem_region_device {
- char *base;
- struct region_device rdev;
-};
-
-/* Iniitalize at runtime a mem_region_device. This would be used when
- * the base and size are dynamic or can't be known during linking. */
-void mem_region_device_init(struct mem_region_device *mdev, void *base,
- size_t size);
-
-extern const struct region_device_ops mem_rdev_ops;
-
-/* Statically initialize mem_region_device. */
-#define MEM_REGION_DEV_INIT(base_, size_) \
- { \
- .base = (void *)(base_), \
- .rdev = REGION_DEV_INIT(&mem_rdev_ops, 0, (size_)), \
- }
-
-struct mmap_helper_region_device {
- struct mem_pool pool;
- struct region_device rdev;
-};
-
-#define MMAP_HELPER_REGION_INIT(ops_, offset_, size_) \
- { \
- .rdev = REGION_DEV_INIT((ops_), (offset_), (size_)), \
- }
-
-void mmap_helper_device_init(struct mmap_helper_region_device *mdev,
- void *cache, size_t cache_size);
-
-void *mmap_helper_rdev_mmap(const struct region_device *, size_t, size_t);
-int mmap_helper_rdev_munmap(const struct region_device *, void *);
-
-#endif /* _REGION_H_ */