1 /* SPDX-License-Identifier: GPL-2.0+ */
2 /*
3 * Test-related constants for sandbox
4 *
5 * Copyright (c) 2014 Google, Inc
6 */
7
8 #ifndef __ASM_TEST_H
9 #define __ASM_TEST_H
10
11 #include <video.h>
12 #include <pci_ids.h>
13
14 struct unit_test_state;
15
16 /* The sandbox driver always permits an I2C device with this address */
17 #define SANDBOX_I2C_TEST_ADDR 0x59
18
19 #define SANDBOX_PCI_VENDOR_ID 0x1234
20 #define SANDBOX_PCI_SWAP_CASE_EMUL_ID 0x5678
21 #define SANDBOX_PCI_PMC_EMUL_ID 0x5677
22 #define SANDBOX_PCI_P2SB_EMUL_ID 0x5676
23 #define SANDBOX_PCI_CLASS_CODE (PCI_CLASS_COMMUNICATION_SERIAL >> 8)
24 #define SANDBOX_PCI_CLASS_SUB_CODE (PCI_CLASS_COMMUNICATION_SERIAL & 0xff)
25
26 #define PCI_CAP_ID_PM_OFFSET 0x50
27 #define PCI_CAP_ID_EXP_OFFSET 0x60
28 #define PCI_CAP_ID_MSIX_OFFSET 0x70
29 #define PCI_CAP_ID_EA_OFFSET 0x80
30
31 #define PCI_EXT_CAP_ID_ERR_OFFSET 0x100
32 #define PCI_EXT_CAP_ID_VC_OFFSET 0x200
33 #define PCI_EXT_CAP_ID_DSN_OFFSET 0x300
34
35 /* Useful for PCI_VDEVICE() macro */
36 #define PCI_VENDOR_ID_SANDBOX SANDBOX_PCI_VENDOR_ID
37 #define SWAP_CASE_DRV_DATA 0x55aa
38
39 #define SANDBOX_CLK_RATE 32768
40
41 /* Macros used to test PCI EA capability structure */
42 #define PCI_CAP_EA_BASE_LO0 0x00100000
43 #define PCI_CAP_EA_BASE_LO1 0x00110000
44 #define PCI_CAP_EA_BASE_LO2 0x00120000
45 #define PCI_CAP_EA_BASE_LO4 0x00140000
46 #define PCI_CAP_EA_BASE_HI2 0x00020000ULL
47 #define PCI_CAP_EA_BASE_HI4 0x00040000ULL
48 #define PCI_CAP_EA_SIZE_LO 0x0000ffff
49 #define PCI_CAP_EA_SIZE_HI 0x00000010ULL
50 #define PCI_EA_BAR2_MAGIC 0x72727272
51 #define PCI_EA_BAR4_MAGIC 0x74747474
52
53 enum {
54 SANDBOX_IRQN_PEND = 1, /* Interrupt number for 'pending' test */
55 };
56
57 /* System controller driver data */
58 enum {
59 SYSCON0 = 32,
60 SYSCON1,
61
62 SYSCON_COUNT
63 };
64
65 /**
66 */
67 enum cros_ec_test_t {
68 CROSECT_BREAK_HELLO = BIT(1),
69 CROSECT_LID_OPEN = BIT(2),
70 };
71
72 /**
73 * sandbox_i2c_set_test_mode() - set test mode for running unit tests
74 *
75 * See sandbox_i2c_xfer() for the behaviour changes.
76 *
77 * @bus: sandbox I2C bus to adjust
78 * @test_mode: true to select test mode, false to run normally
79 */
80 void sandbox_i2c_set_test_mode(struct udevice *bus, bool test_mode);
81
82 enum sandbox_i2c_eeprom_test_mode {
83 SIE_TEST_MODE_NONE,
84 /* Permits read/write of only one byte per I2C transaction */
85 SIE_TEST_MODE_SINGLE_BYTE,
86 };
87
88 void sandbox_i2c_eeprom_set_test_mode(struct udevice *dev,
89 enum sandbox_i2c_eeprom_test_mode mode);
90
91 void sandbox_i2c_eeprom_set_offset_len(struct udevice *dev, int offset_len);
92
93 void sandbox_i2c_eeprom_set_chip_addr_offset_mask(struct udevice *dev,
94 uint mask);
95
96 uint sanbox_i2c_eeprom_get_prev_addr(struct udevice *dev);
97
98 uint sanbox_i2c_eeprom_get_prev_offset(struct udevice *dev);
99
100 /**
101 * sandbox_i2c_rtc_set_offset() - set the time offset from system/base time
102 *
103 * @dev: RTC device to adjust
104 * @use_system_time: true to use system time, false to use @base_time
105 * @offset: RTC offset from current system/base time (-1 for no
106 * change)
107 * Return: old value of RTC offset
108 */
109 long sandbox_i2c_rtc_set_offset(struct udevice *dev, bool use_system_time,
110 int offset);
111
112 /**
113 * sandbox_i2c_rtc_get_set_base_time() - get and set the base time
114 *
115 * @dev: RTC device to adjust
116 * @base_time: New base system time (set to -1 for no change)
117 * Return: old base time
118 */
119 long sandbox_i2c_rtc_get_set_base_time(struct udevice *dev, long base_time);
120
121 int sandbox_usb_keyb_add_string(struct udevice *dev, const char *str);
122
123 /**
124 * sandbox_osd_get_mem() - get the internal memory of a sandbox OSD
125 *
126 * @dev: OSD device for which to access the internal memory for
127 * @buf: pointer to buffer to receive the OSD memory data
128 * @buflen: length of buffer in bytes
129 */
130 int sandbox_osd_get_mem(struct udevice *dev, u8 *buf, size_t buflen);
131
132 /**
133 * sandbox_pwm_get_config() - get the PWM config for a channel
134 *
135 * @dev: Device to check
136 * @channel: Channel number to check
137 * @period_ns: Period of the PWM in nanoseconds
138 * @duty_ns: Current duty cycle of the PWM in nanoseconds
139 * @enable: true if the PWM is enabled
140 * @polarity: true if the PWM polarity is active high
141 * Return: 0 if OK, -ENOSPC if the PWM number is invalid
142 */
143 int sandbox_pwm_get_config(struct udevice *dev, uint channel, uint *period_nsp,
144 uint *duty_nsp, bool *enablep, bool *polarityp);
145
146 /**
147 * sandbox_sf_set_block_protect() - Set the BP bits of the status register
148 *
149 * @dev: Device to update
150 * @bp_mask: BP bits to set (bits 2:0, so a value of 0 to 7)
151 */
152 void sandbox_sf_set_block_protect(struct udevice *dev, int bp_mask);
153
154 /**
155 * sandbox_get_codec_params() - Read back codec parameters
156 *
157 * This reads back the parameters set by audio_codec_set_params() for the
158 * sandbox audio driver. Arguments are as for that function.
159 */
160 void sandbox_get_codec_params(struct udevice *dev, int *interfacep, int *ratep,
161 int *mclk_freqp, int *bits_per_samplep,
162 uint *channelsp);
163
164 /**
165 * sandbox_get_i2s_sum() - Read back the sum of the audio data so far
166 *
167 * This data is provided to the sandbox driver by the I2S tx_data() method.
168 *
169 * @dev: Device to check
170 * Return: sum of audio data
171 */
172 int sandbox_get_i2s_sum(struct udevice *dev);
173
174 /**
175 * sandbox_get_setup_called() - Returns the number of times setup(*) was called
176 *
177 * This is used in the sound test
178 *
179 * @dev: Device to check
180 * Return: call count for the setup() method
181 */
182 int sandbox_get_setup_called(struct udevice *dev);
183
184 /**
185 * sandbox_get_sound_active() - Returns whether sound play is in progress
186 *
187 * Return: true if active, false if not
188 */
189 int sandbox_get_sound_active(struct udevice *dev);
190
191 /**
192 * sandbox_get_sound_count() - Read back the count of the sound data so far
193 *
194 * This data is provided to the sandbox driver by the sound play() method.
195 *
196 * @dev: Device to check
197 * Return: count of audio data
198 */
199 int sandbox_get_sound_count(struct udevice *dev);
200
201 /**
202 * sandbox_get_sound_sum() - Read back the sum of the sound data so far
203 *
204 * This data is provided to the sandbox driver by the sound play() method.
205 *
206 * @dev: Device to check
207 * Return: sum of audio data
208 */
209 int sandbox_get_sound_sum(struct udevice *dev);
210
211 /**
212 * sandbox_set_allow_beep() - Set whether the 'beep' interface is supported
213 *
214 * @dev: Device to update
215 * @allow: true to allow the start_beep() method, false to disallow it
216 */
217 void sandbox_set_allow_beep(struct udevice *dev, bool allow);
218
219 /**
220 * sandbox_get_beep_frequency() - Get the frequency of the current beep
221 *
222 * @dev: Device to check
223 * Return: frequency of beep, if there is an active beep, else 0
224 */
225 int sandbox_get_beep_frequency(struct udevice *dev);
226
227 /**
228 * sandbox_spi_get_speed() - Get current speed setting of a sandbox spi bus
229 *
230 * @dev: Device to check
231 * Return: current bus speed
232 */
233 uint sandbox_spi_get_speed(struct udevice *dev);
234
235 /**
236 * sandbox_spi_get_mode() - Get current mode setting of a sandbox spi bus
237 *
238 * @dev: Device to check
239 * Return: current mode
240 */
241 uint sandbox_spi_get_mode(struct udevice *dev);
242
243 /**
244 * sandbox_get_pch_spi_protect() - Get the PCI SPI protection status
245 *
246 * @dev: Device to check
247 * Return: 0 if not protected, 1 if protected
248 */
249 int sandbox_get_pch_spi_protect(struct udevice *dev);
250
251 /**
252 * sandbox_get_pci_ep_irq_count() - Get the PCI EP IRQ count
253 *
254 * @dev: Device to check
255 * Return: irq count
256 */
257 int sandbox_get_pci_ep_irq_count(struct udevice *dev);
258
259 /**
260 * sandbox_pci_read_bar() - Read the BAR value for a read_config operation
261 *
262 * This is used in PCI emulators to read a base address reset. This has special
263 * rules because when the register is set to 0xffffffff it can be used to
264 * discover the type and size of the BAR.
265 *
266 * @barval: Current value of the BAR
267 * @type: Type of BAR (PCI_BASE_ADDRESS_SPACE_IO or
268 * PCI_BASE_ADDRESS_MEM_TYPE_32)
269 * @size: Size of BAR in bytes
270 * Return: BAR value to return from emulator
271 */
272 uint sandbox_pci_read_bar(u32 barval, int type, uint size);
273
274 /**
275 * sandbox_set_enable_memio() - Enable readl/writel() for sandbox
276 *
277 * Normally these I/O functions do nothing with sandbox. Certain tests need them
278 * to work as for other architectures, so this function can be used to enable
279 * them.
280 *
281 * @enable: true to enable, false to disable
282 */
283 void sandbox_set_enable_memio(bool enable);
284
285 /**
286 * sandbox_cros_ec_set_test_flags() - Set behaviour for testing purposes
287 *
288 * @dev: Device to check
289 * @flags: Flags to control behaviour (CROSECT_...)
290 */
291 void sandbox_cros_ec_set_test_flags(struct udevice *dev, uint flags);
292
293 /**
294 * sandbox_cros_ec_get_pwm_duty() - Get EC PWM config for testing purposes
295 *
296 * @dev: Device to check
297 * @index: PWM channel index
298 * @duty: Current duty cycle in 0..EC_PWM_MAX_DUTY range.
299 * Return: 0 if OK, -ENOSPC if the PWM number is invalid
300 */
301 int sandbox_cros_ec_get_pwm_duty(struct udevice *dev, uint index, uint *duty);
302
303 #if IS_ENABLED(CONFIG_SANDBOX_SDL)
304 /**
305 * sandbox_sdl_set_bpp() - Set the depth of the sandbox display
306 *
307 * The device must not be active when this function is called. It activiates it
308 * before returning.
309 *
310 * This updates the depth value and adjusts a few other settings accordingly.
311 * It must be called before the display is probed.
312 *
313 * @dev: Device to adjust
314 * @l2bpp: depth to set
315 * Return: 0 if the device was already active, other error if it fails to probe
316 * after the change
317 */
318 int sandbox_sdl_set_bpp(struct udevice *dev, enum video_log2_bpp l2bpp);
319 #else
sandbox_sdl_set_bpp(struct udevice * dev,enum video_log2_bpp l2bpp)320 static inline int sandbox_sdl_set_bpp(struct udevice *dev,
321 enum video_log2_bpp l2bpp)
322 {
323 return -ENOSYS;
324 }
325 #endif
326
327 /**
328 * sandbox_set_fake_efi_mgr_dev() - Control EFI bootmgr producing valid bootflow
329 *
330 * This is only used for testing.
331 *
332 * @dev: efi_mgr bootmeth device
333 * @fake_dev: true to produce a valid bootflow when requested, false to produce
334 * an error
335 */
336 void sandbox_set_fake_efi_mgr_dev(struct udevice *dev, bool fake_dev);
337
338 /**
339 * sandbox_load_other_fdt() - load the 'other' FDT into the test state
340 *
341 * This copies the other.dtb file into the test state, so that a fresh version
342 * can be used for a test that is about to run.
343 *
344 * If @uts->other_fdt is NULL, as it is when first set up, this allocates a
345 * buffer for the other FDT and sets @uts->other_fdt_size to its size.
346 *
347 * In any case, the other FDT is copied from the sandbox state into
348 * @uts->other_fdt ready for use.
349 *
350 * @uts: Unit test state
351 * @return 0 if OK, -ve on error
352 */
353 int sandbox_load_other_fdt(void **fdtp, int *sizep);
354
355 /**
356 * sandbox_set_eth_enable() - Enable / disable Ethernet
357 *
358 * Allows control of whether Ethernet packets are actually send/received
359 *
360 * @enable: true to enable Ethernet, false to disable
361 */
362 void sandbox_set_eth_enable(bool enable);
363
364 /**
365 * sandbox_eth_enabled() - Check if Ethernet is enabled
366 *
367 * Returns: true if Ethernet is enabled on sandbox, False if not
368 */
369 bool sandbox_eth_enabled(void);
370
371 /**
372 * sandbox_sf_bootdev_enabled() - Check if SPI flash bootdevs should be bound
373 *
374 * Returns: true if sandbox should bind bootdevs for SPI flash, false if not
375 */
376 bool sandbox_sf_bootdev_enabled(void);
377
378 /**
379 * sandbox_sf_set_enable_bootdevs() - Enable / disable the SPI flash bootdevs
380 *
381 * @enable: true to bind the SPI flash bootdevs, false to skip
382 */
383 void sandbox_sf_set_enable_bootdevs(bool enable);
384
385 #endif
386