Gitiles
Code Review Sign In
192.168.1.100 / T800_MD / 0b80c7188a6089ae59f523c5d460adad05960e1d / . / mcu / interface / driver / peripheral / spmi.h
blob: 82e1011bc7f2a5bf41df4abea3aadf18599eeafd [file] [log] [blame]
rjw6c1fd8f2022-11-30 14:33:01 +0800[diff] [blame]1/* Copyright Statement:
2 *
3 * This software/firmware and related documentation ("MediaTek Software") are
4 * protected under relevant copyright laws. The information contained herein is
5 * confidential and proprietary to MediaTek Inc. and/or its licensors. Without
6 * the prior written permission of MediaTek inc. and/or its licensors, any
7 * reproduction, modification, use or disclosure of MediaTek Software, and
8 * information contained herein, in whole or in part, shall be strictly
9 * prohibited.
10 *
11 * MediaTek Inc. (C) 2019. All rights reserved.
12 *
13 * BY OPENING THIS FILE, RECEIVER HEREBY UNEQUIVOCALLY ACKNOWLEDGES AND AGREES
14 * THAT THE SOFTWARE/FIRMWARE AND ITS DOCUMENTATIONS ("MEDIATEK SOFTWARE")
15 * RECEIVED FROM MEDIATEK AND/OR ITS REPRESENTATIVES ARE PROVIDED TO RECEIVER
16 * ON AN "AS-IS" BASIS ONLY. MEDIATEK EXPRESSLY DISCLAIMS ANY AND ALL
17 * WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR
19 * NONINFRINGEMENT. NEITHER DOES MEDIATEK PROVIDE ANY WARRANTY WHATSOEVER WITH
20 * RESPECT TO THE SOFTWARE OF ANY THIRD PARTY WHICH MAY BE USED BY,
21 * INCORPORATED IN, OR SUPPLIED WITH THE MEDIATEK SOFTWARE, AND RECEIVER AGREES
22 * TO LOOK ONLY TO SUCH THIRD PARTY FOR ANY WARRANTY CLAIM RELATING THERETO.
23 * RECEIVER EXPRESSLY ACKNOWLEDGES THAT IT IS RECEIVER'S SOLE RESPONSIBILITY TO
24 * OBTAIN FROM ANY THIRD PARTY ALL PROPER LICENSES CONTAINED IN MEDIATEK
25 * SOFTWARE. MEDIATEK SHALL ALSO NOT BE RESPONSIBLE FOR ANY MEDIATEK SOFTWARE
26 * RELEASES MADE TO RECEIVER'S SPECIFICATION OR TO CONFORM TO A PARTICULAR
27 * STANDARD OR OPEN FORUM. RECEIVER'S SOLE AND EXCLUSIVE REMEDY AND MEDIATEK'S
28 * ENTIRE AND CUMULATIVE LIABILITY WITH RESPECT TO THE MEDIATEK SOFTWARE
29 * RELEASED HEREUNDER WILL BE, AT MEDIATEK'S OPTION, TO REVISE OR REPLACE THE
30 * MEDIATEK SOFTWARE AT ISSUE, OR REFUND ANY SOFTWARE LICENSE FEES OR SERVICE
31 * CHARGE PAID BY RECEIVER TO MEDIATEK FOR SUCH MEDIATEK SOFTWARE AT ISSUE.
32 *
33 * The following software/firmware and/or related documentation ("MediaTek
34 * Software") have been modified by MediaTek Inc. All revisions are subject to
35 * any receiver's applicable license agreements with MediaTek Inc.
36 */
37#ifndef __SPMI_H__
38#define __SPMI_H__
39#define SPMI_GROUP_ID 0xB
40
41/* Maximum slave identifier */
42#define SPMI_MAX_SLAVE_ID 16
43
44/* SPMI Commands */
45#define SPMI_CMD_EXT_WRITE 0x00
46#define SPMI_CMD_RESET 0x10
47#define SPMI_CMD_SLEEP 0x11
48#define SPMI_CMD_SHUTDOWN 0x12
49#define SPMI_CMD_WAKEUP 0x13
50#define SPMI_CMD_AUTHENTICATE 0x14
51#define SPMI_CMD_MSTR_READ 0x15
52#define SPMI_CMD_MSTR_WRITE 0x16
53#define SPMI_CMD_TRANSFER_BUS_OWNERSHIP 0x1A
54#define SPMI_CMD_DDB_MASTER_READ 0x1B
55#define SPMI_CMD_DDB_SLAVE_READ 0x1C
56#define SPMI_CMD_EXT_READ 0x20
57#define SPMI_CMD_EXT_WRITEL 0x30
58#define SPMI_CMD_EXT_READL 0x38
59#define SPMI_CMD_WRITE 0x40
60#define SPMI_CMD_READ 0x60
61#define SPMI_CMD_ZERO_WRITE 0x80
62
63/* enum marco for cmd/channel */
64enum
65{
66 SPMI_MASTER_0 = 0,
67 SPMI_MASTER_1,
68 SPMI_MASTER_P_1,
69 SPMI_MASTER_MAX
70};
71
72enum
73{
74 SPMI_SLAVE_0 = 0,
75 SPMI_SLAVE_1,
76 SPMI_SLAVE_2,
77 SPMI_SLAVE_3,
78 SPMI_SLAVE_4,
79 SPMI_SLAVE_5,
80 SPMI_SLAVE_6,
81 SPMI_SLAVE_7,
82 SPMI_SLAVE_8,
83 SPMI_SLAVE_9,
84 SPMI_SLAVE_10,
85 SPMI_SLAVE_11,
86 SPMI_SLAVE_12,
87 SPMI_SLAVE_13,
88 SPMI_SLAVE_14,
89 SPMI_SLAVE_15
90};
91
92enum slv_type
93{
94 BUCK_CPU,
95 BUCK_GPU,
96 BUCK_MD,
97 BUCK_RF,
98 MAIN_PMIC,
99 BUCK_VPU,
100 SUB_PMIC,
101 SLV_TYPE_MAX
102};
103
104enum slv_type_id
105{
106 BUCK_RF_ID = 1,
107 BUCK_MD_ID = 3,
108 MAIN_PMIC_ID = 5,
109 BUCK_CPU_ID = 6,
110 BUCK_GPU_ID = 7,
111 BUCK_VPU_ID,
112 SUB_PMIC_ID = 10,
113 SLV_TYPE_ID_MAX
114};
115
116struct spmi_device {
117 int slvid;
118 int grpiden;
119 enum slv_type type;
120 enum slv_type_id type_id;
121 int mstid;
122 unsigned short hwcid_addr;
123 unsigned char hwcid_val;
124 unsigned short swcid_addr;
125 unsigned char swcid_val;
126 struct pmif *pmif_arb;
127};
128
129/* external API */
130int spmi_register_zero_write(struct spmi_device *dev,
131 unsigned int addr, unsigned char data);
132int spmi_register_read(struct spmi_device *dev,
133 unsigned int addr, unsigned char *buf);
134int spmi_register_write(struct spmi_device *dev,
135 unsigned int addr, unsigned char data);
136int spmi_ext_register_read(struct spmi_device *dev,
137 unsigned int addr, unsigned char *buf, unsigned short len);
138int spmi_ext_register_write(struct spmi_device *dev,
139 unsigned int addr, const unsigned char *buf, unsigned short len);
140int spmi_ext_register_readl(struct spmi_device *dev, unsigned int addr,
141 unsigned char *buf, unsigned short len);
142int spmi_ext_register_writel(struct spmi_device *dev, unsigned int addr,
143 const unsigned char *buf, unsigned short len);
144int spmi_ext_register_readl_field(struct spmi_device *dev, unsigned int addr,
145 unsigned char *buf, unsigned short len, unsigned short mask,
146 unsigned short shift);
147int spmi_ext_register_writel_field(struct spmi_device *dev, unsigned int addr,
148 const unsigned char *buf, unsigned short len, unsigned short mask,
149 unsigned short shift);
150
151#endif /*__SPMI_H__*/