OMAP2/3/4 core: create omap_device layer

# OCPI interconnect support for 1710, 1610 and 5912

obj-$(CONFIG_ARCH_OMAP16XX) += ocpi.o

# omap_device support (OMAP2+ only at the moment)

obj-$(CONFIG_ARCH_OMAP2) += omap_device.o

obj-$(CONFIG_ARCH_OMAP3) += omap_device.o

obj-$(CONFIG_OMAP_MCBSP) += mcbsp.o

obj-$(CONFIG_OMAP_IOMMU) += iommu.o iovmm.o

obj-$(CONFIG_OMAP_IOMMU_DEBUG) += iommu-debug.o

/*

 * omap_device headers

 *

 * Copyright (C) 2009 Nokia Corporation

 * Paul Walmsley

 *

 * Developed in collaboration with (alphabetical order): Benoit

 * Cousson, Kevin Hilman, Tony Lindgren, Rajendra Nayak, Vikram

 * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard

 * Woodruff

 *

 * This program is free software; you can redistribute it and/or modify

 * it under the terms of the GNU General Public License version 2 as

 * published by the Free Software Foundation.

 *

 * Eventually this type of functionality should either be

 * a) implemented via arch-specific pointers in platform_device

 * or

 * b) implemented as a proper omap_bus/omap_device in Linux, no more

 *    platform_device

 *

 * omap_device differs from omap_hwmod in that it includes external

 * (e.g., board- and system-level) integration details.  omap_hwmod

 * stores hardware data that is invariant for a given OMAP chip.

 *

 * To do:

 * - GPIO integration

 * - regulator integration

 *

 */

#ifndef __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H

#define __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H

#include <linux/kernel.h>

#include <linux/platform_device.h>

#include <mach/omap_hwmod.h>

/* omap_device._state values */

#define OMAP_DEVICE_STATE_UNKNOWN	0

#define OMAP_DEVICE_STATE_ENABLED	1

#define OMAP_DEVICE_STATE_IDLE		2

#define OMAP_DEVICE_STATE_SHUTDOWN	3

/**

 * struct omap_device - omap_device wrapper for platform_devices

 * @pdev: platform_device

 * @hwmods: (one .. many per omap_device)

 * @hwmods_cnt: ARRAY_SIZE() of @hwmods

 * @pm_lats: ptr to an omap_device_pm_latency table

 * @pm_lats_cnt: ARRAY_SIZE() of what is passed to @pm_lats

 * @pm_lat_level: array index of the last odpl entry executed - -1 if never

 * @dev_wakeup_lat: dev wakeup latency in microseconds

 * @_dev_wakeup_lat_limit: dev wakeup latency limit in usec - set by OMAP PM

 * @_state: one of OMAP_DEVICE_STATE_* (see above)

 * @flags: device flags

 *

 * Integrates omap_hwmod data into Linux platform_device.

 *

 * Field names beginning with underscores are for the internal use of

 * the omap_device code.

 *

 */

struct omap_device {

	struct platform_device		pdev;

	struct omap_hwmod		**hwmods;

	struct omap_device_pm_latency	*pm_lats;

	u32				dev_wakeup_lat;

	u32				_dev_wakeup_lat_limit;

	u8				pm_lats_cnt;

	s8				pm_lat_level;

	u8				hwmods_cnt;

	u8				_state;

};

/* Device driver interface (call via platform_data fn ptrs) */

int omap_device_enable(struct platform_device *pdev);

int omap_device_idle(struct platform_device *pdev);

int omap_device_shutdown(struct platform_device *pdev);

/* Core code interface */

int omap_device_count_resources(struct omap_device *od);

int omap_device_fill_resources(struct omap_device *od, struct resource *res);

struct omap_device *omap_device_build(const char *pdev_name, int pdev_id,

				      struct omap_hwmod *oh, void *pdata,

				      int pdata_len,

				      struct omap_device_pm_latency *pm_lats,

				      int pm_lats_cnt);

struct omap_device *omap_device_build_ss(const char *pdev_name, int pdev_id,

					 struct omap_hwmod **oh, int oh_cnt,

					 void *pdata, int pdata_len,

					 struct omap_device_pm_latency *pm_lats,

					 int pm_lats_cnt);

int omap_device_register(struct omap_device *od);

/* OMAP PM interface */

int omap_device_align_pm_lat(struct platform_device *pdev,

			     u32 new_wakeup_lat_limit);

struct powerdomain *omap_device_get_pwrdm(struct omap_device *od);

/* Other */

int omap_device_idle_hwmods(struct omap_device *od);

int omap_device_enable_hwmods(struct omap_device *od);

int omap_device_disable_clocks(struct omap_device *od);

int omap_device_enable_clocks(struct omap_device *od);

/*

 * Entries should be kept in latency order ascending

 *

 * deact_lat is the maximum number of microseconds required to complete

 * deactivate_func() at the device's slowest OPP.

 *

 * act_lat is the maximum number of microseconds required to complete

 * activate_func() at the device's slowest OPP.

 *

 * This will result in some suboptimal power management decisions at fast

 * OPPs, but avoids having to recompute all device power management decisions

 * if the system shifts from a fast OPP to a slow OPP (in order to meet

 * latency requirements).

 *

 * XXX should deactivate_func/activate_func() take platform_device pointers

 * rather than omap_device pointers?

 */

struct omap_device_pm_latency {

	u32 deactivate_lat;

	int (*deactivate_func)(struct omap_device *od);

	u32 activate_lat;

	int (*activate_func)(struct omap_device *od);

};

#endif