libshmeram
===========

libshmeram: A library for accessing the SH-Mobile MERAM

Copyright (C) 2011 Igel Co., Ltd.
Copyright (C) 2011 Renesas Electronics Corporation

The [SH-Mobile][0] processor series includes a memory caching unit for media 
access from the devices various hardware blocks, including VEU, VPU, JPU, etc.
The memory caching unit can read-ahead and write-back access to the system
memory as well as local storage for data being transferred between two media
blocks.

This source archive contains:

 * src/libshmeram: the libshmeram shared library

libshmeram API
------------

Compilation
-----------

# autoreconf -vif
# ./configure (for cross compile add '--host=arm-linux-gnueabi')
# make

Installation
------------
# make install

* libshmeram requires a 'meram.conf' file to operate. This file will be
  automatically created in '(root dir)/etc', but may need to be copied to
  a target rootfs if using cross-compilation, i.e:

# cp (root dir)/etc/meram.conf (target rootfs)/etc


SH-Mobile
---------
[0]: http://www.renesas.com/fmwk.jsp?cnt=sh_mobile_family_landing.jsp&fp=/products/mpumcu/sh_mobile/

Kernel configuration
--------------------

libshmeram uses the Linux kernel UIO support for the SH-Mobile MERAM, which was
added in 2.6.27.

License
-------

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.

This library 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
Library General Public License for more details.

You should have received a copy of the GNU Library General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA  02110-1301 USA

See the file COPYING for details.