blob: b432a83675411d698407b2999155f55a04d09727 [file] [log] [blame]
Soren Brinkmann76fcae32016-03-06 20:16:27 -08001/*
2 * Copyright (c) 2013-2015, ARM Limited and Contributors. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are met:
6 *
7 * Redistributions of source code must retain the above copyright notice, this
8 * list of conditions and the following disclaimer.
9 *
10 * Redistributions in binary form must reproduce the above copyright notice,
11 * this list of conditions and the following disclaimer in the documentation
12 * and/or other materials provided with the distribution.
13 *
14 * Neither the name of ARM nor the names of its contributors may be used
15 * to endorse or promote products derived from this software without specific
16 * prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
22 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28 * POSSIBILITY OF SUCH DAMAGE.
29 */
30
31/*
32 * Contains definitions of commonly used macros and data types needed
33 * for PU Power Management. This file should be common for all PU's.
34 */
35
36#ifndef _PM_COMMON_H_
37#define _PM_COMMON_H_
38
39#include <debug.h>
40#include <stdint.h>
41#include "pm_defs.h"
42
43#define PAYLOAD_ARG_CNT 6U
44#define PAYLOAD_ARG_SIZE 4U /* size in bytes */
45
46/**
47 * pm_ipi - struct for capturing IPI-channel specific info
48 * @mask mask for enabling/disabling and triggering the IPI
49 * @base base address for IPI
50 * @buffer_base base address for payload buffer
51 */
52struct pm_ipi {
53 const unsigned int mask;
54 const uintptr_t base;
55 const uintptr_t buffer_base;
56};
57
58/**
59 * pm_proc - struct for capturing processor related info
60 * @node_id node-ID of the processor
61 * @pwrdn_mask cpu-specific mask to be used for power control register
62 * @ipi pointer to IPI channel structure
63 * (in APU all processors share one IPI channel)
64 */
65struct pm_proc {
66 const enum pm_node_id node_id;
67 const unsigned int pwrdn_mask;
68 const struct pm_ipi *ipi;
69};
70
71const struct pm_proc *pm_get_proc(unsigned int cpuid);
72const struct pm_proc *pm_get_proc_by_node(enum pm_node_id nid);
73
74#endif /* _PM_COMMON_H_ */