blob: ced775e401cfec70811db7b6b6c73bfb3243cdf2 [file] [log] [blame]
Thomas Gleixnerd2912cb2019-06-04 10:11:33 +02001/* SPDX-License-Identifier: GPL-2.0-only */
Paul Walmsleyb04b65a2009-09-03 20:14:05 +03002/*
3 * omap_device headers
4 *
5 * Copyright (C) 2009 Nokia Corporation
6 * Paul Walmsley
7 *
8 * Developed in collaboration with (alphabetical order): Benoit
9 * Cousson, Kevin Hilman, Tony Lindgren, Rajendra Nayak, Vikram
10 * Pandita, Sakari Poussa, Anand Sawant, Santosh Shilimkar, Richard
11 * Woodruff
12 *
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -070013 * This type of functionality should be implemented as a proper
14 * omap_bus/omap_device in Linux.
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030015 *
16 * omap_device differs from omap_hwmod in that it includes external
17 * (e.g., board- and system-level) integration details. omap_hwmod
18 * stores hardware data that is invariant for a given OMAP chip.
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030019 */
20#ifndef __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
21#define __ARCH_ARM_PLAT_OMAP_INCLUDE_MACH_OMAP_DEVICE_H
22
23#include <linux/kernel.h>
24#include <linux/platform_device.h>
25
Tony Lindgren2a296c82012-10-02 17:41:35 -070026#include "omap_hwmod.h"
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030027
Kevin Hilman3ec2dec2012-02-15 11:47:45 -080028extern struct dev_pm_domain omap_device_pm_domain;
Nishanth Menonf5c33b02013-12-03 19:39:13 -060029extern struct dev_pm_domain omap_device_fail_pm_domain;
Kevin Hilman0d5e8252010-08-23 08:10:55 -070030
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030031/* omap_device._state values */
32#define OMAP_DEVICE_STATE_UNKNOWN 0
33#define OMAP_DEVICE_STATE_ENABLED 1
34#define OMAP_DEVICE_STATE_IDLE 2
35#define OMAP_DEVICE_STATE_SHUTDOWN 3
36
Kevin Hilmanc03f0072011-07-12 22:48:19 +020037/* omap_device.flags values */
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -070038#define OMAP_DEVICE_SUSPENDED BIT(0)
Kevin Hilmanc03f0072011-07-12 22:48:19 +020039
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030040/**
41 * struct omap_device - omap_device wrapper for platform_devices
42 * @pdev: platform_device
43 * @hwmods: (one .. many per omap_device)
44 * @hwmods_cnt: ARRAY_SIZE() of @hwmods
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030045 * @_state: one of OMAP_DEVICE_STATE_* (see above)
46 * @flags: device flags
Kevin Hilmane7533452012-07-10 11:13:16 -070047 * @_driver_status: one of BUS_NOTIFY_*_DRIVER from <linux/device.h>
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030048 *
49 * Integrates omap_hwmod data into Linux platform_device.
50 *
51 * Field names beginning with underscores are for the internal use of
52 * the omap_device code.
53 *
54 */
55struct omap_device {
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070056 struct platform_device *pdev;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030057 struct omap_hwmod **hwmods;
Kevin Hilmane7533452012-07-10 11:13:16 -070058 unsigned long _driver_status;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030059 u8 hwmods_cnt;
60 u8 _state;
Kevin Hilmanc03f0072011-07-12 22:48:19 +020061 u8 flags;
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030062};
63
64/* Device driver interface (call via platform_data fn ptrs) */
65
66int omap_device_enable(struct platform_device *pdev);
67int omap_device_idle(struct platform_device *pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030068
69/* Core code interface */
70
Kevin Hilman3528c582011-07-21 13:48:45 -070071struct platform_device *omap_device_build(const char *pdev_name, int pdev_id,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -070072 struct omap_hwmod *oh, void *pdata,
73 int pdata_len);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030074
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -080075struct omap_device *omap_device_alloc(struct platform_device *pdev,
Paul Walmsleyc1d1cd52013-01-26 00:48:53 -070076 struct omap_hwmod **ohs, int oh_cnt);
Ohad Ben-Cohen993e4fb2012-02-20 09:43:29 -080077void omap_device_delete(struct omap_device *od);
78int omap_device_register(struct platform_device *pdev);
79
Nishanth Menon1f8a7d52011-07-27 15:02:32 -050080struct device *omap_device_get_by_hwmod_name(const char *oh_name);
Paul Walmsleydb2a60b2010-07-26 16:34:33 -060081
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030082/* OMAP PM interface */
Tomi Valkeinenfc013872011-06-09 16:56:23 +030083int omap_device_get_context_loss_count(struct platform_device *pdev);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030084
85/* Other */
86
Omar Ramirez Luna8bb9fde2012-09-23 17:28:18 -060087int omap_device_assert_hardreset(struct platform_device *pdev,
88 const char *name);
89int omap_device_deassert_hardreset(struct platform_device *pdev,
90 const char *name);
Paul Walmsleyb04b65a2009-09-03 20:14:05 +030091
Kevin Hilmana470c422009-12-08 16:34:17 -070092/* Get omap_device pointer from platform_device pointer */
Kevin Hilmand66b3fe2011-07-21 13:58:51 -070093static inline struct omap_device *to_omap_device(struct platform_device *pdev)
94{
95 return pdev ? pdev->archdata.od : NULL;
96}
Kevin Hilmana470c422009-12-08 16:34:17 -070097#endif