usb: gadget: udc: pch_udc: Fix a plethora of function documentation related issues
[linux/fpc-iii.git] / arch / mips / loongson2ef / lemote-2f / ec_kb3310b.h
blobaecdbc9c875ab06cfdc5924a3bcdf2adf87a6e38
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /*
3 * KB3310B Embedded Controller
5 * Copyright (C) 2008 Lemote Inc.
6 * Author: liujl <liujl@lemote.com>, 2008-03-14
7 */
9 #ifndef _EC_KB3310B_H
10 #define _EC_KB3310B_H
12 extern unsigned char ec_read(unsigned short addr);
13 extern void ec_write(unsigned short addr, unsigned char val);
14 extern int ec_query_seq(unsigned char cmd);
15 extern int ec_query_event_num(void);
16 extern int ec_get_event_num(void);
18 typedef int (*sci_handler) (int status);
19 extern sci_handler yeeloong_report_lid_status;
21 #define SCI_IRQ_NUM 0x0A
24 * The following registers are determined by the EC index configuration.
25 * 1, fill the PORT_HIGH as EC register high part.
26 * 2, fill the PORT_LOW as EC register low part.
27 * 3, fill the PORT_DATA as EC register write data or get the data from it.
29 #define EC_IO_PORT_HIGH 0x0381
30 #define EC_IO_PORT_LOW 0x0382
31 #define EC_IO_PORT_DATA 0x0383
34 * EC delay time is 500us for register and status access
36 #define EC_REG_DELAY 500 /* unit : us */
37 #define EC_CMD_TIMEOUT 0x1000
40 * EC access port for SCI communication
42 #define EC_CMD_PORT 0x66
43 #define EC_STS_PORT 0x66
44 #define EC_DAT_PORT 0x62
45 #define CMD_INIT_IDLE_MODE 0xdd
46 #define CMD_EXIT_IDLE_MODE 0xdf
47 #define CMD_INIT_RESET_MODE 0xd8
48 #define CMD_REBOOT_SYSTEM 0x8c
49 #define CMD_GET_EVENT_NUM 0x84
50 #define CMD_PROGRAM_PIECE 0xda
52 /* temperature & fan registers */
53 #define REG_TEMPERATURE_VALUE 0xF458
54 #define REG_FAN_AUTO_MAN_SWITCH 0xF459
55 #define BIT_FAN_AUTO 0
56 #define BIT_FAN_MANUAL 1
57 #define REG_FAN_CONTROL 0xF4D2
58 #define BIT_FAN_CONTROL_ON (1 << 0)
59 #define BIT_FAN_CONTROL_OFF (0 << 0)
60 #define REG_FAN_STATUS 0xF4DA
61 #define BIT_FAN_STATUS_ON (1 << 0)
62 #define BIT_FAN_STATUS_OFF (0 << 0)
63 #define REG_FAN_SPEED_HIGH 0xFE22
64 #define REG_FAN_SPEED_LOW 0xFE23
65 #define REG_FAN_SPEED_LEVEL 0xF4CC
66 /* fan speed divider */
67 #define FAN_SPEED_DIVIDER 480000 /* (60*1000*1000/62.5/2)*/
69 /* battery registers */
70 #define REG_BAT_DESIGN_CAP_HIGH 0xF77D
71 #define REG_BAT_DESIGN_CAP_LOW 0xF77E
72 #define REG_BAT_FULLCHG_CAP_HIGH 0xF780
73 #define REG_BAT_FULLCHG_CAP_LOW 0xF781
74 #define REG_BAT_DESIGN_VOL_HIGH 0xF782
75 #define REG_BAT_DESIGN_VOL_LOW 0xF783
76 #define REG_BAT_CURRENT_HIGH 0xF784
77 #define REG_BAT_CURRENT_LOW 0xF785
78 #define REG_BAT_VOLTAGE_HIGH 0xF786
79 #define REG_BAT_VOLTAGE_LOW 0xF787
80 #define REG_BAT_TEMPERATURE_HIGH 0xF788
81 #define REG_BAT_TEMPERATURE_LOW 0xF789
82 #define REG_BAT_RELATIVE_CAP_HIGH 0xF492
83 #define REG_BAT_RELATIVE_CAP_LOW 0xF493
84 #define REG_BAT_VENDOR 0xF4C4
85 #define FLAG_BAT_VENDOR_SANYO 0x01
86 #define FLAG_BAT_VENDOR_SIMPLO 0x02
87 #define REG_BAT_CELL_COUNT 0xF4C6
88 #define FLAG_BAT_CELL_3S1P 0x03
89 #define FLAG_BAT_CELL_3S2P 0x06
90 #define REG_BAT_CHARGE 0xF4A2
91 #define FLAG_BAT_CHARGE_DISCHARGE 0x01
92 #define FLAG_BAT_CHARGE_CHARGE 0x02
93 #define FLAG_BAT_CHARGE_ACPOWER 0x00
94 #define REG_BAT_STATUS 0xF4B0
95 #define BIT_BAT_STATUS_LOW (1 << 5)
96 #define BIT_BAT_STATUS_DESTROY (1 << 2)
97 #define BIT_BAT_STATUS_FULL (1 << 1)
98 #define BIT_BAT_STATUS_IN (1 << 0)
99 #define REG_BAT_CHARGE_STATUS 0xF4B1
100 #define BIT_BAT_CHARGE_STATUS_OVERTEMP (1 << 2)
101 #define BIT_BAT_CHARGE_STATUS_PRECHG (1 << 1)
102 #define REG_BAT_STATE 0xF482
103 #define BIT_BAT_STATE_CHARGING (1 << 1)
104 #define BIT_BAT_STATE_DISCHARGING (1 << 0)
105 #define REG_BAT_POWER 0xF440
106 #define BIT_BAT_POWER_S3 (1 << 2)
107 #define BIT_BAT_POWER_ON (1 << 1)
108 #define BIT_BAT_POWER_ACIN (1 << 0)
110 /* other registers */
111 /* Audio: rd/wr */
112 #define REG_AUDIO_VOLUME 0xF46C
113 #define REG_AUDIO_MUTE 0xF4E7
114 #define REG_AUDIO_BEEP 0xF4D0
115 /* USB port power or not: rd/wr */
116 #define REG_USB0_FLAG 0xF461
117 #define REG_USB1_FLAG 0xF462
118 #define REG_USB2_FLAG 0xF463
119 #define BIT_USB_FLAG_ON 1
120 #define BIT_USB_FLAG_OFF 0
121 /* LID */
122 #define REG_LID_DETECT 0xF4BD
123 #define BIT_LID_DETECT_ON 1
124 #define BIT_LID_DETECT_OFF 0
125 /* CRT */
126 #define REG_CRT_DETECT 0xF4AD
127 #define BIT_CRT_DETECT_PLUG 1
128 #define BIT_CRT_DETECT_UNPLUG 0
129 /* LCD backlight brightness adjust: 9 levels */
130 #define REG_DISPLAY_BRIGHTNESS 0xF4F5
131 /* Black screen Status */
132 #define BIT_DISPLAY_LCD_ON 1
133 #define BIT_DISPLAY_LCD_OFF 0
134 /* LCD backlight control: off/restore */
135 #define REG_BACKLIGHT_CTRL 0xF7BD
136 #define BIT_BACKLIGHT_ON 1
137 #define BIT_BACKLIGHT_OFF 0
138 /* Reset the machine auto-clear: rd/wr */
139 #define REG_RESET 0xF4EC
140 #define BIT_RESET_ON 1
141 /* Light the led: rd/wr */
142 #define REG_LED 0xF4C8
143 #define BIT_LED_RED_POWER (1 << 0)
144 #define BIT_LED_ORANGE_POWER (1 << 1)
145 #define BIT_LED_GREEN_CHARGE (1 << 2)
146 #define BIT_LED_RED_CHARGE (1 << 3)
147 #define BIT_LED_NUMLOCK (1 << 4)
148 /* Test led mode, all led on/off */
149 #define REG_LED_TEST 0xF4C2
150 #define BIT_LED_TEST_IN 1
151 #define BIT_LED_TEST_OUT 0
152 /* Camera on/off */
153 #define REG_CAMERA_STATUS 0xF46A
154 #define BIT_CAMERA_STATUS_ON 1
155 #define BIT_CAMERA_STATUS_OFF 0
156 #define REG_CAMERA_CONTROL 0xF7B7
157 #define BIT_CAMERA_CONTROL_OFF 0
158 #define BIT_CAMERA_CONTROL_ON 1
159 /* Wlan Status */
160 #define REG_WLAN 0xF4FA
161 #define BIT_WLAN_ON 1
162 #define BIT_WLAN_OFF 0
163 #define REG_DISPLAY_LCD 0xF79F
165 /* SCI Event Number from EC */
166 enum {
167 EVENT_LID = 0x23, /* LID open/close */
168 EVENT_DISPLAY_TOGGLE, /* Fn+F3 for display switch */
169 EVENT_SLEEP, /* Fn+F1 for entering sleep mode */
170 EVENT_OVERTEMP, /* Over-temperature happened */
171 EVENT_CRT_DETECT, /* CRT is connected */
172 EVENT_CAMERA, /* Camera on/off */
173 EVENT_USB_OC2, /* USB2 Over Current occurred */
174 EVENT_USB_OC0, /* USB0 Over Current occurred */
175 EVENT_BLACK_SCREEN, /* Turn on/off backlight */
176 EVENT_AUDIO_MUTE, /* Mute on/off */
177 EVENT_DISPLAY_BRIGHTNESS,/* LCD backlight brightness adjust */
178 EVENT_AC_BAT, /* AC & Battery relative issue */
179 EVENT_AUDIO_VOLUME, /* Volume adjust */
180 EVENT_WLAN, /* Wlan on/off */
181 EVENT_END
184 #endif /* !_EC_KB3310B_H */