SuperH Interfaces Guide


Paul Mundt

Memory Management


Store Queue API

void sq_flush_range(unsigned long start, unsigned int len)

Flush (prefetch) a specific SQ range


unsigned long start

the store queue address to start flushing from

unsigned int len

the length to flush


Flushes the store queue cache from start to start + len in a linear fashion.

unsigned long sq_remap(unsigned long phys, unsigned int size, const char *name, pgprot_t prot)

Map a physical address through the Store Queues


unsigned long phys

Physical address of mapping.

unsigned int size

Length of mapping.

const char *name

User invoking mapping.

pgprot_t prot

Protection bits.


Remaps the physical address phys through the next available store queue address of size length. name is logged at boot time as well as through the sysfs interface.

void sq_unmap(unsigned long vaddr)

Unmap a Store Queue allocation


unsigned long vaddr

Pre-allocated Store Queue mapping.


Unmaps the store queue allocation map that was previously created by sq_remap(). Also frees up the pte that was previously inserted into the kernel page table and discards the UTLB translation.

Machine Specific Interfaces


int aica_rtc_gettimeofday(struct device *dev, struct rtc_time *tm)

Get the time from the AICA RTC


struct device *dev

the RTC device (ignored)

struct rtc_time *tm

pointer to resulting RTC time structure


Grabs the current RTC seconds counter and adjusts it to the Unix Epoch.

int aica_rtc_settimeofday(struct device *dev, struct rtc_time *tm)

Set the AICA RTC to the current time


struct device *dev

the RTC device (ignored)

struct rtc_time *tm

pointer to new RTC time structure


Adjusts the given tv to the AICA Epoch and sets the RTC seconds counter.


int ilsel_enable(ilsel_source_t set)

Enable an ILSEL set.


ilsel_source_t set

ILSEL source (see ilsel_source_t enum in include/asm-sh/ilsel.h).


Enables a given non-aliased ILSEL source (<= ILSEL_KEY) at the highest available interrupt level. Callers should take care to order callsites noting descending interrupt levels. Aliasing FPGA and external board IRQs need to use ilsel_enable_fixed().

The return value is an IRQ number that can later be taken down with ilsel_disable().

int ilsel_enable_fixed(ilsel_source_t set, unsigned int level)

Enable an ILSEL set at a fixed interrupt level


ilsel_source_t set

ILSEL source (see ilsel_source_t enum in include/asm-sh/ilsel.h).

unsigned int level

Interrupt level (1 - 15)


Enables a given ILSEL source at a fixed interrupt level. Necessary both for level reservation as well as for aliased sources that only exist on special ILSEL#s.

Returns an IRQ number (as ilsel_enable()).

void ilsel_disable(unsigned int irq)

Disable an ILSEL set


unsigned int irq

Bit position for ILSEL set value (retval from enable routines)


Disable a previously enabled ILSEL set.



int superhyway_add_device(unsigned long base, struct superhyway_device *sdev, struct superhyway_bus *bus)

Add a SuperHyway module


unsigned long base

Physical address where module is mapped.

struct superhyway_device *sdev

SuperHyway device to add, or NULL to allocate a new one.

struct superhyway_bus *bus

Bus where SuperHyway module resides.


This is responsible for adding a new SuperHyway module. This sets up a new struct superhyway_device for the module being added if sdev == NULL.

Devices are initially added in the order that they are scanned (from the top-down of the memory map), and are assigned an ID based on the order that they are added. Any manual addition of a module will thus get the ID after the devices already discovered regardless of where it resides in memory.

Further work can and should be done in superhyway_scan_bus(), to be sure that any new modules are properly discovered and subsequently registered.

int superhyway_register_driver(struct superhyway_driver *drv)

Register a new SuperHyway driver


struct superhyway_driver *drv

SuperHyway driver to register.


This registers the passed in drv. Any devices matching the id table will automatically be populated and handed off to the driver's specified probe routine.

void superhyway_unregister_driver(struct superhyway_driver *drv)

Unregister a SuperHyway driver


struct superhyway_driver *drv

SuperHyway driver to unregister.


This cleans up after superhyway_register_driver(), and should be invoked in the exit path of any module drivers.


int maple_driver_register(struct maple_driver *drv)

register a maple driver


struct maple_driver *drv

maple driver to be registered.


Registers the passed in drv, while updating the bus type. Devices with matching function IDs will be automatically probed.

void maple_driver_unregister(struct maple_driver *drv)

unregister a maple driver.


struct maple_driver *drv

maple driver to unregister.


Cleans up after maple_driver_register(). To be invoked in the exit path of any module drivers.

void maple_getcond_callback(struct maple_device *dev, void (*callback)(struct mapleq *mq), unsigned long interval, unsigned long function)



struct maple_device *dev

device responding

void (*callback) (struct mapleq *mq)

handler callback

unsigned long interval

interval in jiffies between callbacks

unsigned long function

the function code for the device

int maple_add_packet(struct maple_device *mdev, u32 function, u32 command, size_t length, void *data)

add a single instruction to the maple bus queue


struct maple_device *mdev

maple device

u32 function

function on device being queried

u32 command

maple command to add

size_t length

length of command string (in 32 bit words)

void *data

remainder of command string