michaelh/zephyr
1
0
Fork 0
Code Releases Activity
zephyr/soc/arm/nuvoton_npcx/common/soc_espi.h

55 lines
1.3 KiB
C
Raw Normal View History

driver: espi: add acpi and customized op codes for lpc r/w request func. This CL introduces two kinds of op codes for espi_api_lpc_read_request and espi_api_lpc_write_request Zephyr espi api functions. One is for supporting ACPI and shared memory region to access ACPI data. The other is customized for certain platforms such as Chromebook and so on. This CL also introduced the following configurations to add the flexibility of these settings. 1. ESPI_PERIPHERAL_ACPI_SHM_REGION_PORT_NUM: Host I/O peripheral port number for shared memory region. The default value is default 0x0900 2. ESPI_NPCX_PERIPHERAL_ACPI_SHD_MEM_SIZE: Host I/O peripheral port size for shared memory in npcx series. Please notice the valid value in npcx ec series for this option is 8/16/32/64/128/256/512/1024/2048/4096 bytes. The default value is 256 bytes. This CL also turn off hardware-wire feature which generates VW events that connected to hardware signals such as SMI and SCI. We will set VW output events directly via espi_api_send_vwire() api function. Signed-off-by: Mulin Chao <mlchao@nuvoton.com>
2020-12-09 21:28:48 -08:00
/*
* Copyright (c) 2020 Nuvoton Technology Corporation.
*
* SPDX-License-Identifier: Apache-2.0
*/
#ifndef _NUVOTON_NPCX_SOC_ESPI_H_
#define _NUVOTON_NPCX_SOC_ESPI_H_
#ifdef __cplusplus
extern "C" {
#endif
/* 8042 event data format */
driver: espi: add more KBC 8042 support in npcx series. This CL added more additional details for KBC (Keyboard and Mouse Controller) bus in espi_event structure. It helps the application to handle different 8042 events in the callback function. The format of event data for KBC 8042 protocol is: [23:16] - 8042 event type: 1: Input buf full, 2: Output buf empty. [15:8] - 8042 data: 8-bit 8042 data. [0:7] - 8042 protocol type: 0: data type, 1: command type. Signed-off-by: Mulin Chao <mlchao@nuvoton.com>
2021-01-28 23:45:17 -08:00
#define NPCX_8042_EVT_POS 16U
driver: espi: add acpi and customized op codes for lpc r/w request func. This CL introduces two kinds of op codes for espi_api_lpc_read_request and espi_api_lpc_write_request Zephyr espi api functions. One is for supporting ACPI and shared memory region to access ACPI data. The other is customized for certain platforms such as Chromebook and so on. This CL also introduced the following configurations to add the flexibility of these settings. 1. ESPI_PERIPHERAL_ACPI_SHM_REGION_PORT_NUM: Host I/O peripheral port number for shared memory region. The default value is default 0x0900 2. ESPI_NPCX_PERIPHERAL_ACPI_SHD_MEM_SIZE: Host I/O peripheral port size for shared memory in npcx series. Please notice the valid value in npcx ec series for this option is 8/16/32/64/128/256/512/1024/2048/4096 bytes. The default value is 256 bytes. This CL also turn off hardware-wire feature which generates VW events that connected to hardware signals such as SMI and SCI. We will set VW output events directly via espi_api_send_vwire() api function. Signed-off-by: Mulin Chao <mlchao@nuvoton.com>
2020-12-09 21:28:48 -08:00
#define NPCX_8042_DATA_POS 8U
#define NPCX_8042_TYPE_POS 0U
driver: espi: add more KBC 8042 support in npcx series. This CL added more additional details for KBC (Keyboard and Mouse Controller) bus in espi_event structure. It helps the application to handle different 8042 events in the callback function. The format of event data for KBC 8042 protocol is: [23:16] - 8042 event type: 1: Input buf full, 2: Output buf empty. [15:8] - 8042 data: 8-bit 8042 data. [0:7] - 8042 protocol type: 0: data type, 1: command type. Signed-off-by: Mulin Chao <mlchao@nuvoton.com>
2021-01-28 23:45:17 -08:00
/* 8042 event type format */
#define NPCX_8042_EVT_IBF BIT(0)
#define NPCX_8042_EVT_OBE BIT(1)
/*
* The format of event data for KBC 8042 protocol:
* [23:16] - 8042 event type: 1: Input buffer full, 2: Output buffer empty.
* [15:8] - 8042 data: 8-bit 8042 data.
* [0:7] - 8042 protocol type: 0: data type, 1: command type.
*/
#define NPCX_8042_EVT_DATA(event, data, type) (((event) << NPCX_8042_EVT_POS) \
| ((data) << NPCX_8042_DATA_POS) | ((type) << NPCX_8042_TYPE_POS));
driver: espi: add acpi and customized op codes for lpc r/w request func. This CL introduces two kinds of op codes for espi_api_lpc_read_request and espi_api_lpc_write_request Zephyr espi api functions. One is for supporting ACPI and shared memory region to access ACPI data. The other is customized for certain platforms such as Chromebook and so on. This CL also introduced the following configurations to add the flexibility of these settings. 1. ESPI_PERIPHERAL_ACPI_SHM_REGION_PORT_NUM: Host I/O peripheral port number for shared memory region. The default value is default 0x0900 2. ESPI_NPCX_PERIPHERAL_ACPI_SHD_MEM_SIZE: Host I/O peripheral port size for shared memory in npcx series. Please notice the valid value in npcx ec series for this option is 8/16/32/64/128/256/512/1024/2048/4096 bytes. The default value is 256 bytes. This CL also turn off hardware-wire feature which generates VW events that connected to hardware signals such as SMI and SCI. We will set VW output events directly via espi_api_send_vwire() api function. Signed-off-by: Mulin Chao <mlchao@nuvoton.com>
2020-12-09 21:28:48 -08:00
/* ACPI event data format */
#define NPCX_ACPI_DATA_POS 8U
#define NPCX_ACPI_TYPE_POS 0U
/**
* @brief Turn on all interrupts of eSPI host interface module.
*
* @param dev Pointer to structure device of eSPI module
*/
void npcx_espi_enable_interrupts(const struct device *dev);
/**
* @brief Turn off all interrupts of eSPI host interface module.
*
* @param dev Pointer to structure device of eSPI module
*/
void npcx_espi_disable_interrupts(const struct device *dev);
#ifdef __cplusplus
}
#endif
#endif /* _NUVOTON_NPCX_SOC_ESPI_H_ */
Copy permalink