// SPDX-License-Identifier: GPL-2.0 /* Copyright (c) 2012-2018, The Linux Foundation. All rights reserved. * Copyright (C) 2018-2024 Linaro Ltd. */ #include <linux/delay.h> #include <linux/io.h> #include <linux/pm_runtime.h> #include <linux/types.h> #include "ipa.h" #include "ipa_interrupt.h" #include "ipa_power.h" #include "ipa_reg.h" #include "ipa_uc.h" /** * DOC: The IPA embedded microcontroller * * The IPA incorporates a microcontroller that is able to do some additional * handling/offloading of network activity. The current code makes * essentially no use of the microcontroller, but it still requires some * initialization. It needs to be notified in the event the AP crashes. * * The microcontroller can generate two interrupts to the AP. One interrupt * is used to indicate that a response to a request from the AP is available. * The other is used to notify the AP of the occurrence of an event. In * addition, the AP can interrupt the microcontroller by writing a register. * * A 128 byte block of structured memory within the IPA SRAM is used together * with these interrupts to implement the communication interface between the * AP and the IPA microcontroller. Each side writes data to the shared area * before interrupting its peer, which will read the written data in response * to the interrupt. Some information found in the shared area is currently * unused. All remaining space in the shared area is reserved, and must not * be read or written by the AP. */ /* Supports hardware interface version 0x2000 */ /* Delay to allow a the microcontroller to save state when crashing */ #define IPA_SEND_DELAY … /** * struct ipa_uc_mem_area - AP/microcontroller shared memory area * @command: command code (AP->microcontroller) * @reserved0: reserved bytes; avoid reading or writing * @command_param: low 32 bits of command parameter (AP->microcontroller) * @command_param_hi: high 32 bits of command parameter (AP->microcontroller) * * @response: response code (microcontroller->AP) * @reserved1: reserved bytes; avoid reading or writing * @response_param: response parameter (microcontroller->AP) * * @event: event code (microcontroller->AP) * @reserved2: reserved bytes; avoid reading or writing * @event_param: event parameter (microcontroller->AP) * * @first_error_address: address of first error-source on SNOC * @hw_state: state of hardware (including error type information) * @warning_counter: counter of non-fatal hardware errors * @reserved3: reserved bytes; avoid reading or writing * @interface_version: hardware-reported interface version * @reserved4: reserved bytes; avoid reading or writing * * A shared memory area at the base of IPA resident memory is used for * communication with the microcontroller. The region is 128 bytes in * size, but only the first 40 bytes (structured this way) are used. */ struct ipa_uc_mem_area { … }; /** enum ipa_uc_command - commands from the AP to the microcontroller */ enum ipa_uc_command { … }; /** enum ipa_uc_response - microcontroller response codes */ enum ipa_uc_response { … }; /** enum ipa_uc_event - common cpu events reported by the microcontroller */ enum ipa_uc_event { … }; static struct ipa_uc_mem_area *ipa_uc_shared(struct ipa *ipa) { … } /* Microcontroller event IPA interrupt handler */ static void ipa_uc_event_handler(struct ipa *ipa) { … } /* Microcontroller response IPA interrupt handler */ static void ipa_uc_response_hdlr(struct ipa *ipa) { … } void ipa_uc_interrupt_handler(struct ipa *ipa, enum ipa_irq_id irq_id) { … } /* Configure the IPA microcontroller subsystem */ void ipa_uc_config(struct ipa *ipa) { … } /* Inverse of ipa_uc_config() */ void ipa_uc_deconfig(struct ipa *ipa) { … } /* Take a proxy power reference for the microcontroller */ void ipa_uc_power(struct ipa *ipa) { … } /* Send a command to the microcontroller */ static void send_uc_command(struct ipa *ipa, u32 command, u32 command_param) { … } /* Tell the microcontroller the AP is shutting down */ void ipa_uc_panic_notifier(struct ipa *ipa) { … }