Tom Rini | 10e4779 | 2018-05-06 17:58:06 -0400 | [diff] [blame] | 1 | /* SPDX-License-Identifier: GPL-2.0+ */ |
Simon Glass | 45be32c | 2014-12-10 08:55:51 -0700 | [diff] [blame] | 2 | /* |
| 3 | * Test-related constants for sandbox |
| 4 | * |
| 5 | * Copyright (c) 2014 Google, Inc |
Simon Glass | 45be32c | 2014-12-10 08:55:51 -0700 | [diff] [blame] | 6 | */ |
| 7 | |
| 8 | #ifndef __ASM_TEST_H |
| 9 | #define __ASM_TEST_H |
| 10 | |
Simon Glass | c3b5adf | 2021-11-19 13:23:50 -0700 | [diff] [blame] | 11 | #include <video.h> |
| 12 | |
Simon Glass | 45be32c | 2014-12-10 08:55:51 -0700 | [diff] [blame] | 13 | /* The sandbox driver always permits an I2C device with this address */ |
Simon Glass | 70778bc | 2015-03-05 12:25:26 -0700 | [diff] [blame] | 14 | #define SANDBOX_I2C_TEST_ADDR 0x59 |
| 15 | |
| 16 | #define SANDBOX_PCI_VENDOR_ID 0x1234 |
Simon Glass | 21c8f1a | 2019-09-25 08:56:01 -0600 | [diff] [blame] | 17 | #define SANDBOX_PCI_SWAP_CASE_EMUL_ID 0x5678 |
Simon Glass | 8c50102 | 2019-12-06 21:41:54 -0700 | [diff] [blame] | 18 | #define SANDBOX_PCI_PMC_EMUL_ID 0x5677 |
Simon Glass | 937bb47 | 2019-12-06 21:41:57 -0700 | [diff] [blame] | 19 | #define SANDBOX_PCI_P2SB_EMUL_ID 0x5676 |
Simon Glass | 70778bc | 2015-03-05 12:25:26 -0700 | [diff] [blame] | 20 | #define SANDBOX_PCI_CLASS_CODE PCI_CLASS_CODE_COMM |
| 21 | #define SANDBOX_PCI_CLASS_SUB_CODE PCI_CLASS_SUB_CODE_COMM_SERIAL |
Simon Glass | 45be32c | 2014-12-10 08:55:51 -0700 | [diff] [blame] | 22 | |
Bin Meng | d74d312 | 2018-08-03 01:14:53 -0700 | [diff] [blame] | 23 | #define PCI_CAP_ID_PM_OFFSET 0x50 |
| 24 | #define PCI_CAP_ID_EXP_OFFSET 0x60 |
| 25 | #define PCI_CAP_ID_MSIX_OFFSET 0x70 |
Alex Marginean | f127443 | 2019-06-07 11:24:24 +0300 | [diff] [blame] | 26 | #define PCI_CAP_ID_EA_OFFSET 0x80 |
Bin Meng | d74d312 | 2018-08-03 01:14:53 -0700 | [diff] [blame] | 27 | |
| 28 | #define PCI_EXT_CAP_ID_ERR_OFFSET 0x100 |
| 29 | #define PCI_EXT_CAP_ID_VC_OFFSET 0x200 |
| 30 | #define PCI_EXT_CAP_ID_DSN_OFFSET 0x300 |
| 31 | |
Bin Meng | c69ae41 | 2018-08-03 01:14:46 -0700 | [diff] [blame] | 32 | /* Useful for PCI_VDEVICE() macro */ |
| 33 | #define PCI_VENDOR_ID_SANDBOX SANDBOX_PCI_VENDOR_ID |
| 34 | #define SWAP_CASE_DRV_DATA 0x55aa |
| 35 | |
Simon Glass | 8cc4d82 | 2015-07-06 12:54:24 -0600 | [diff] [blame] | 36 | #define SANDBOX_CLK_RATE 32768 |
| 37 | |
Alex Marginean | f127443 | 2019-06-07 11:24:24 +0300 | [diff] [blame] | 38 | /* Macros used to test PCI EA capability structure */ |
| 39 | #define PCI_CAP_EA_BASE_LO0 0x00100000 |
| 40 | #define PCI_CAP_EA_BASE_LO1 0x00110000 |
| 41 | #define PCI_CAP_EA_BASE_LO2 0x00120000 |
| 42 | #define PCI_CAP_EA_BASE_LO4 0x00140000 |
| 43 | #define PCI_CAP_EA_BASE_HI2 0x00020000ULL |
| 44 | #define PCI_CAP_EA_BASE_HI4 0x00040000ULL |
| 45 | #define PCI_CAP_EA_SIZE_LO 0x0000ffff |
| 46 | #define PCI_CAP_EA_SIZE_HI 0x00000010ULL |
| 47 | #define PCI_EA_BAR2_MAGIC 0x72727272 |
| 48 | #define PCI_EA_BAR4_MAGIC 0x74747474 |
| 49 | |
Simon Glass | a847b27 | 2020-02-06 09:54:57 -0700 | [diff] [blame] | 50 | enum { |
| 51 | SANDBOX_IRQN_PEND = 1, /* Interrupt number for 'pending' test */ |
| 52 | }; |
| 53 | |
Simon Glass | cd55652 | 2015-07-06 12:54:35 -0600 | [diff] [blame] | 54 | /* System controller driver data */ |
| 55 | enum { |
| 56 | SYSCON0 = 32, |
| 57 | SYSCON1, |
| 58 | |
| 59 | SYSCON_COUNT |
| 60 | }; |
| 61 | |
Simon Glass | 4c70ed9 | 2015-04-20 12:37:15 -0600 | [diff] [blame] | 62 | /** |
Simon Glass | 9b306e5 | 2021-01-16 14:52:22 -0700 | [diff] [blame] | 63 | */ |
| 64 | enum cros_ec_test_t { |
| 65 | CROSECT_BREAK_HELLO = BIT(1), |
Simon Glass | 9d70252 | 2021-01-16 14:52:28 -0700 | [diff] [blame] | 66 | CROSECT_LID_OPEN = BIT(2), |
Simon Glass | 9b306e5 | 2021-01-16 14:52:22 -0700 | [diff] [blame] | 67 | }; |
| 68 | |
| 69 | /** |
Simon Glass | 4c70ed9 | 2015-04-20 12:37:15 -0600 | [diff] [blame] | 70 | * sandbox_i2c_set_test_mode() - set test mode for running unit tests |
| 71 | * |
| 72 | * See sandbox_i2c_xfer() for the behaviour changes. |
| 73 | * |
| 74 | * @bus: sandbox I2C bus to adjust |
| 75 | * @test_mode: true to select test mode, false to run normally |
| 76 | */ |
| 77 | void sandbox_i2c_set_test_mode(struct udevice *bus, bool test_mode); |
| 78 | |
Simon Glass | 45be32c | 2014-12-10 08:55:51 -0700 | [diff] [blame] | 79 | enum sandbox_i2c_eeprom_test_mode { |
| 80 | SIE_TEST_MODE_NONE, |
| 81 | /* Permits read/write of only one byte per I2C transaction */ |
| 82 | SIE_TEST_MODE_SINGLE_BYTE, |
| 83 | }; |
| 84 | |
| 85 | void sandbox_i2c_eeprom_set_test_mode(struct udevice *dev, |
| 86 | enum sandbox_i2c_eeprom_test_mode mode); |
| 87 | |
| 88 | void sandbox_i2c_eeprom_set_offset_len(struct udevice *dev, int offset_len); |
| 89 | |
Robert Beckett | f695f6e | 2019-10-28 17:44:59 +0000 | [diff] [blame] | 90 | void sandbox_i2c_eeprom_set_chip_addr_offset_mask(struct udevice *dev, |
| 91 | uint mask); |
| 92 | |
Robert Beckett | 1fe8a49 | 2019-10-28 17:44:58 +0000 | [diff] [blame] | 93 | uint sanbox_i2c_eeprom_get_prev_addr(struct udevice *dev); |
| 94 | |
| 95 | uint sanbox_i2c_eeprom_get_prev_offset(struct udevice *dev); |
| 96 | |
Simon Glass | c404aa6 | 2015-04-20 12:37:24 -0600 | [diff] [blame] | 97 | /** |
| 98 | * sandbox_i2c_rtc_set_offset() - set the time offset from system/base time |
| 99 | * |
| 100 | * @dev: RTC device to adjust |
| 101 | * @use_system_time: true to use system time, false to use @base_time |
| 102 | * @offset: RTC offset from current system/base time (-1 for no |
| 103 | * change) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 104 | * Return: old value of RTC offset |
Simon Glass | c404aa6 | 2015-04-20 12:37:24 -0600 | [diff] [blame] | 105 | */ |
| 106 | long sandbox_i2c_rtc_set_offset(struct udevice *dev, bool use_system_time, |
| 107 | int offset); |
| 108 | |
| 109 | /** |
| 110 | * sandbox_i2c_rtc_get_set_base_time() - get and set the base time |
| 111 | * |
| 112 | * @dev: RTC device to adjust |
| 113 | * @base_time: New base system time (set to -1 for no change) |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 114 | * Return: old base time |
Simon Glass | c404aa6 | 2015-04-20 12:37:24 -0600 | [diff] [blame] | 115 | */ |
| 116 | long sandbox_i2c_rtc_get_set_base_time(struct udevice *dev, long base_time); |
| 117 | |
Simon Glass | be4ebd1 | 2015-11-08 23:48:06 -0700 | [diff] [blame] | 118 | int sandbox_usb_keyb_add_string(struct udevice *dev, const char *str); |
| 119 | |
Mario Six | 02ad6fb | 2018-09-27 09:19:31 +0200 | [diff] [blame] | 120 | /** |
| 121 | * sandbox_osd_get_mem() - get the internal memory of a sandbox OSD |
| 122 | * |
| 123 | * @dev: OSD device for which to access the internal memory for |
| 124 | * @buf: pointer to buffer to receive the OSD memory data |
| 125 | * @buflen: length of buffer in bytes |
| 126 | */ |
| 127 | int sandbox_osd_get_mem(struct udevice *dev, u8 *buf, size_t buflen); |
Simon Glass | 5620cf8 | 2018-10-01 12:22:40 -0600 | [diff] [blame] | 128 | |
| 129 | /** |
| 130 | * sandbox_pwm_get_config() - get the PWM config for a channel |
| 131 | * |
| 132 | * @dev: Device to check |
| 133 | * @channel: Channel number to check |
| 134 | * @period_ns: Period of the PWM in nanoseconds |
| 135 | * @duty_ns: Current duty cycle of the PWM in nanoseconds |
| 136 | * @enable: true if the PWM is enabled |
| 137 | * @polarity: true if the PWM polarity is active high |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 138 | * Return: 0 if OK, -ENOSPC if the PWM number is invalid |
Simon Glass | 5620cf8 | 2018-10-01 12:22:40 -0600 | [diff] [blame] | 139 | */ |
| 140 | int sandbox_pwm_get_config(struct udevice *dev, uint channel, uint *period_nsp, |
| 141 | uint *duty_nsp, bool *enablep, bool *polarityp); |
| 142 | |
Simon Glass | 36eee8c | 2018-11-06 15:21:41 -0700 | [diff] [blame] | 143 | /** |
| 144 | * sandbox_sf_set_block_protect() - Set the BP bits of the status register |
| 145 | * |
| 146 | * @dev: Device to update |
| 147 | * @bp_mask: BP bits to set (bits 2:0, so a value of 0 to 7) |
| 148 | */ |
| 149 | void sandbox_sf_set_block_protect(struct udevice *dev, int bp_mask); |
| 150 | |
Simon Glass | ed96cde | 2018-12-10 10:37:33 -0700 | [diff] [blame] | 151 | /** |
| 152 | * sandbox_get_codec_params() - Read back codec parameters |
| 153 | * |
| 154 | * This reads back the parameters set by audio_codec_set_params() for the |
| 155 | * sandbox audio driver. Arguments are as for that function. |
| 156 | */ |
| 157 | void sandbox_get_codec_params(struct udevice *dev, int *interfacep, int *ratep, |
| 158 | int *mclk_freqp, int *bits_per_samplep, |
| 159 | uint *channelsp); |
| 160 | |
Simon Glass | c953aaf | 2018-12-10 10:37:34 -0700 | [diff] [blame] | 161 | /** |
| 162 | * sandbox_get_i2s_sum() - Read back the sum of the audio data so far |
| 163 | * |
| 164 | * This data is provided to the sandbox driver by the I2S tx_data() method. |
| 165 | * |
| 166 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 167 | * Return: sum of audio data |
Simon Glass | c953aaf | 2018-12-10 10:37:34 -0700 | [diff] [blame] | 168 | */ |
| 169 | int sandbox_get_i2s_sum(struct udevice *dev); |
| 170 | |
Simon Glass | 76072ac | 2018-12-10 10:37:36 -0700 | [diff] [blame] | 171 | /** |
| 172 | * sandbox_get_setup_called() - Returns the number of times setup(*) was called |
| 173 | * |
| 174 | * This is used in the sound test |
| 175 | * |
| 176 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 177 | * Return: call count for the setup() method |
Simon Glass | 76072ac | 2018-12-10 10:37:36 -0700 | [diff] [blame] | 178 | */ |
| 179 | int sandbox_get_setup_called(struct udevice *dev); |
| 180 | |
| 181 | /** |
Simon Glass | 70bc14b | 2020-02-03 07:36:06 -0700 | [diff] [blame] | 182 | * sandbox_get_sound_active() - Returns whether sound play is in progress |
| 183 | * |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 184 | * Return: true if active, false if not |
Simon Glass | 70bc14b | 2020-02-03 07:36:06 -0700 | [diff] [blame] | 185 | */ |
| 186 | int sandbox_get_sound_active(struct udevice *dev); |
| 187 | |
| 188 | /** |
Simon Glass | 76072ac | 2018-12-10 10:37:36 -0700 | [diff] [blame] | 189 | * sandbox_get_sound_sum() - Read back the sum of the sound data so far |
| 190 | * |
| 191 | * This data is provided to the sandbox driver by the sound play() method. |
| 192 | * |
| 193 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 194 | * Return: sum of audio data |
Simon Glass | 76072ac | 2018-12-10 10:37:36 -0700 | [diff] [blame] | 195 | */ |
| 196 | int sandbox_get_sound_sum(struct udevice *dev); |
| 197 | |
Simon Glass | 53a68b3 | 2019-02-16 20:24:50 -0700 | [diff] [blame] | 198 | /** |
Simon Glass | ecd02e7 | 2019-02-16 20:24:54 -0700 | [diff] [blame] | 199 | * sandbox_set_allow_beep() - Set whether the 'beep' interface is supported |
| 200 | * |
| 201 | * @dev: Device to update |
| 202 | * @allow: true to allow the start_beep() method, false to disallow it |
| 203 | */ |
| 204 | void sandbox_set_allow_beep(struct udevice *dev, bool allow); |
| 205 | |
| 206 | /** |
| 207 | * sandbox_get_beep_frequency() - Get the frequency of the current beep |
| 208 | * |
| 209 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 210 | * Return: frequency of beep, if there is an active beep, else 0 |
Simon Glass | ecd02e7 | 2019-02-16 20:24:54 -0700 | [diff] [blame] | 211 | */ |
| 212 | int sandbox_get_beep_frequency(struct udevice *dev); |
| 213 | |
| 214 | /** |
Ovidiu Panait | a2c9d01 | 2020-12-14 19:06:49 +0200 | [diff] [blame] | 215 | * sandbox_spi_get_speed() - Get current speed setting of a sandbox spi bus |
| 216 | * |
| 217 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 218 | * Return: current bus speed |
Ovidiu Panait | a2c9d01 | 2020-12-14 19:06:49 +0200 | [diff] [blame] | 219 | */ |
| 220 | uint sandbox_spi_get_speed(struct udevice *dev); |
| 221 | |
| 222 | /** |
| 223 | * sandbox_spi_get_mode() - Get current mode setting of a sandbox spi bus |
| 224 | * |
| 225 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 226 | * Return: current mode |
Ovidiu Panait | a2c9d01 | 2020-12-14 19:06:49 +0200 | [diff] [blame] | 227 | */ |
| 228 | uint sandbox_spi_get_mode(struct udevice *dev); |
| 229 | |
| 230 | /** |
Simon Glass | 53a68b3 | 2019-02-16 20:24:50 -0700 | [diff] [blame] | 231 | * sandbox_get_pch_spi_protect() - Get the PCI SPI protection status |
| 232 | * |
| 233 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 234 | * Return: 0 if not protected, 1 if protected |
Simon Glass | 53a68b3 | 2019-02-16 20:24:50 -0700 | [diff] [blame] | 235 | */ |
| 236 | int sandbox_get_pch_spi_protect(struct udevice *dev); |
| 237 | |
Ramon Fried | afdb342 | 2019-04-27 11:15:24 +0300 | [diff] [blame] | 238 | /** |
| 239 | * sandbox_get_pci_ep_irq_count() - Get the PCI EP IRQ count |
| 240 | * |
| 241 | * @dev: Device to check |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 242 | * Return: irq count |
Ramon Fried | afdb342 | 2019-04-27 11:15:24 +0300 | [diff] [blame] | 243 | */ |
| 244 | int sandbox_get_pci_ep_irq_count(struct udevice *dev); |
| 245 | |
Simon Glass | 72231f7 | 2019-09-25 08:56:42 -0600 | [diff] [blame] | 246 | /** |
| 247 | * sandbox_pci_read_bar() - Read the BAR value for a read_config operation |
| 248 | * |
| 249 | * This is used in PCI emulators to read a base address reset. This has special |
| 250 | * rules because when the register is set to 0xffffffff it can be used to |
| 251 | * discover the type and size of the BAR. |
| 252 | * |
| 253 | * @barval: Current value of the BAR |
| 254 | * @type: Type of BAR (PCI_BASE_ADDRESS_SPACE_IO or |
| 255 | * PCI_BASE_ADDRESS_MEM_TYPE_32) |
| 256 | * @size: Size of BAR in bytes |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 257 | * Return: BAR value to return from emulator |
Simon Glass | 72231f7 | 2019-09-25 08:56:42 -0600 | [diff] [blame] | 258 | */ |
| 259 | uint sandbox_pci_read_bar(u32 barval, int type, uint size); |
| 260 | |
Simon Glass | c667fb0 | 2019-10-11 16:16:48 -0600 | [diff] [blame] | 261 | /** |
| 262 | * sandbox_set_enable_memio() - Enable readl/writel() for sandbox |
| 263 | * |
| 264 | * Normally these I/O functions do nothing with sandbox. Certain tests need them |
| 265 | * to work as for other architectures, so this function can be used to enable |
| 266 | * them. |
| 267 | * |
| 268 | * @enable: true to enable, false to disable |
| 269 | */ |
| 270 | void sandbox_set_enable_memio(bool enable); |
| 271 | |
Simon Glass | 9b306e5 | 2021-01-16 14:52:22 -0700 | [diff] [blame] | 272 | /** |
| 273 | * sandbox_cros_ec_set_test_flags() - Set behaviour for testing purposes |
| 274 | * |
| 275 | * @dev: Device to check |
| 276 | * @flags: Flags to control behaviour (CROSECT_...) |
| 277 | */ |
| 278 | void sandbox_cros_ec_set_test_flags(struct udevice *dev, uint flags); |
| 279 | |
Alper Nebi Yasak | 8a8cd4f | 2021-05-19 19:33:31 +0300 | [diff] [blame] | 280 | /** |
| 281 | * sandbox_cros_ec_get_pwm_duty() - Get EC PWM config for testing purposes |
| 282 | * |
| 283 | * @dev: Device to check |
| 284 | * @index: PWM channel index |
| 285 | * @duty: Current duty cycle in 0..EC_PWM_MAX_DUTY range. |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 286 | * Return: 0 if OK, -ENOSPC if the PWM number is invalid |
Alper Nebi Yasak | 8a8cd4f | 2021-05-19 19:33:31 +0300 | [diff] [blame] | 287 | */ |
| 288 | int sandbox_cros_ec_get_pwm_duty(struct udevice *dev, uint index, uint *duty); |
| 289 | |
Simon Glass | c3b5adf | 2021-11-19 13:23:50 -0700 | [diff] [blame] | 290 | /** |
| 291 | * sandbox_sdl_set_bpp() - Set the depth of the sandbox display |
| 292 | * |
| 293 | * The device must not be active when this function is called. It activiates it |
| 294 | * before returning. |
| 295 | * |
| 296 | * This updates the depth value and adjusts a few other settings accordingly. |
| 297 | * It must be called before the display is probed. |
| 298 | * |
| 299 | * @dev: Device to adjust |
| 300 | * @l2bpp: depth to set |
Heinrich Schuchardt | 47b4c02 | 2022-01-19 18:05:50 +0100 | [diff] [blame] | 301 | * Return: 0 if the device was already active, other error if it fails to probe |
Simon Glass | c3b5adf | 2021-11-19 13:23:50 -0700 | [diff] [blame] | 302 | * after the change |
| 303 | */ |
| 304 | int sandbox_sdl_set_bpp(struct udevice *dev, enum video_log2_bpp l2bpp); |
| 305 | |
Simon Glass | 45be32c | 2014-12-10 08:55:51 -0700 | [diff] [blame] | 306 | #endif |