From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mx0b-0031df01.pphosted.com (mx0b-0031df01.pphosted.com [205.220.180.131]) by mx.groups.io with SMTP id smtpd.web10.62724.1669941319419796791 for ; Thu, 01 Dec 2022 16:35:19 -0800 Authentication-Results: mx.groups.io; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=kVZC9gWW; spf=permerror, err=parse error for token &{10 18 %{ir}.%{v}.%{d}.spf.has.pphosted.com}: invalid domain name (domain: quicinc.com, ip: 205.220.180.131, mailfrom: quic_rcran@quicinc.com) Received: from pps.filterd (m0279870.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.19/8.17.1.19) with ESMTP id 2B20ZGWO017909; Fri, 2 Dec 2022 00:35:16 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=from : to : cc : subject : date : message-id : in-reply-to : references : mime-version : content-transfer-encoding : content-type; s=qcppdkim1; bh=iBx4iBggsijISPPoRRneJBXyz4EN3xOsf5rrIqrxoZ8=; b=kVZC9gWWh5p1Xsv00SP16MO6gozQ8zhLASUHNCWM3X+IeCqJRes2y3/0YX8xDRMN0F+I +gLDMGvlmxxYxJZTpEV1cvgclpk/BPbiG9iMe7oqao9Y1AcgqmLRLncYZICFBvcA5/Q/ D/qoYTd3p/NLjOt35Mh1wgGQuInl+6gJzMZoRSJcmzwC90BbooEGv3hEy4JJqkBeNb1L 8O9HLaesECYaY01eLPRhMae/l9gX0+rBTg3U+YErVvTzsSr4o0z/aU5VTWS0atcZkpxl goBDx5/1X1CitET+EACixgppTlM9o+e9E9brhvwc+P7Jske51+Mf9rAf9CPFz/wOQbna ZQ== Received: from nalasppmta05.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3m6kgmk92u-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 02 Dec 2022 00:35:15 +0000 Received: from nalasex01a.na.qualcomm.com (nalasex01a.na.qualcomm.com [10.47.209.196]) by NALASPPMTA05.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 2B20ZE3I022831 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Fri, 2 Dec 2022 00:35:14 GMT Received: from linbox.qualcomm.com (10.80.80.8) by nalasex01a.na.qualcomm.com (10.47.209.196) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.2.986.36; Thu, 1 Dec 2022 16:35:14 -0800 From: "Rebecca Cran" To: , Leif Lindholm , "Sami Mujawar" , Ard Biesheuvel CC: Rebecca Cran Subject: [PATCH 2/2] ArmPkg: Improve formatting of docs in ArmExceptionLib/ArmExceptionLib.c Date: Thu, 1 Dec 2022 17:34:57 -0700 Message-ID: <20221202003457.81701-3-rebecca@quicinc.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20221202003457.81701-1-rebecca@quicinc.com> References: <20221202003457.81701-1-rebecca@quicinc.com> MIME-Version: 1.0 X-Originating-IP: [10.80.80.8] X-ClientProxiedBy: nasanex01b.na.qualcomm.com (10.46.141.250) To nalasex01a.na.qualcomm.com (10.47.209.196) X-QCInternal: smtphost X-Proofpoint-Virus-Version: vendor=nai engine=6200 definitions=5800 signatures=585085 X-Proofpoint-ORIG-GUID: EIvtHYGpFwIaYRE-mvqX4xbB1oww8gEf X-Proofpoint-GUID: EIvtHYGpFwIaYRE-mvqX4xbB1oww8gEf X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.219,Aquarius:18.0.923,Hydra:6.0.545,FMLib:17.11.122.1 definitions=2022-12-01_14,2022-12-01_01,2022-06-22_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 priorityscore=1501 suspectscore=0 spamscore=0 impostorscore=0 phishscore=0 bulkscore=0 mlxscore=0 lowpriorityscore=0 mlxlogscore=953 malwarescore=0 clxscore=1015 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2210170000 definitions=main-2212020003 Content-Transfer-Encoding: 8bit Content-Type: text/plain Improve the formatting of the documentation for functions in ArmExceptionLib/ArmExceptionLib.c. Signed-off-by: Rebecca Cran --- ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c | 115 +++++++++++--------- 1 file changed, 64 insertions(+), 51 deletions(-) diff --git a/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c b/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c index b20472008b3f..057ab3a9f201 100644 --- a/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c +++ b/ArmPkg/Library/ArmExceptionLib/ArmExceptionLib.c @@ -69,19 +69,24 @@ STATIC CONST BOOLEAN gArmRelocateVectorTable = FALSE; #endif /** -Initializes all CPU exceptions entries and provides the default exception handlers. + Initializes all CPU exceptions entries and provides the default exception + handlers. -Caller should try to get an array of interrupt and/or exception vectors that are in use and need to -persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification. -If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL. -If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly. + Caller should try to get an array of interrupt and/or exception vectors that + are in use and need to persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 + specification. + If caller cannot get reserved vector list or it does not exists, set + VectorInfo to NULL. + If VectorInfo is not NULL, the exception vectors will be initialized per + vector attribute accordingly. -@param[in] VectorInfo Pointer to reserved vector list. + @param[in] VectorInfo Pointer to reserved vector list. -@retval EFI_SUCCESS CPU Exception Entries have been successfully initialized -with default exception handlers. -@retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL. -@retval EFI_UNSUPPORTED This function is not supported. + @retval EFI_SUCCESS CPU Exception Entries have been successfully + initialized with default exception handlers. + @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if + VectorInfo is not NULL. + @retval EFI_UNSUPPORTED This function is not supported. **/ EFI_STATUS @@ -130,19 +135,23 @@ InitializeCpuExceptionHandlers ( } /** -Copies exception handlers to the specified address. + Copies exception handlers to the specified address. -Caller should try to get an array of interrupt and/or exception vectors that are in use and need to -persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 specification. -If caller cannot get reserved vector list or it does not exists, set VectorInfo to NULL. -If VectorInfo is not NULL, the exception vectors will be initialized per vector attribute accordingly. + Caller should try to get an array of interrupt and/or exception vectors that + are in use and need to persist by EFI_VECTOR_HANDOFF_INFO defined in PI 1.3 + specification. + If caller cannot get reserved vector list or it does not exists, set + VectorInfo to NULL. + If VectorInfo is not NULL, the exception vectors will be initialized per + vector attribute accordingly. -@param[in] BaseAddress Address to copy exception handlers to. + @param[in] BaseAddress Address to copy exception handlers to. -@retval EFI_SUCCESS CPU Exception Entries have been successfully initialized -with default exception handlers. -@retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if VectorInfo is not NULL. -@retval EFI_UNSUPPORTED This function is not supported. + @retval EFI_SUCCESS CPU Exception Entries have been successfully + initialized with default exception handlers. + @retval EFI_INVALID_PARAMETER VectorInfo includes the invalid content if + VectorInfo is not NULL. + @retval EFI_UNSUPPORTED This function is not supported. **/ STATIC @@ -196,29 +205,33 @@ CopyExceptionHandlers ( } /** -Registers a function to be called from the processor exception handler. (On ARM/AArch64 this only -provides exception handlers, not interrupt handling which is provided through the Hardware Interrupt -Protocol.) + Registers a function to be called from the processor exception handler. + (On ARM/AArch64 this only provides exception handlers, not interrupt handling + which is provided through the Hardware Interrupt Protocol.) -This function registers and enables the handler specified by ExceptionHandler for a processor -interrupt or exception type specified by ExceptionType. If ExceptionHandler is NULL, then the -handler for the processor interrupt or exception type specified by ExceptionType is uninstalled. -The installed handler is called once for each processor interrupt or exception. -NOTE: This function should be invoked after InitializeCpuExceptionHandlers() is invoked, -otherwise EFI_UNSUPPORTED returned. + This function registers and enables the handler specified by ExceptionHandler + for a processor interrupt or exception type specified by ExceptionType. If + ExceptionHandler is NULL, then the handler for the processor interrupt or + exception type specified by ExceptionType is uninstalled. + The installed handler is called once for each processor interrupt or + exception. + NOTE: This function should be invoked after InitializeCpuExceptionHandlers() + is invoked, otherwise EFI_UNSUPPORTED returned. -@param[in] ExceptionType Defines which interrupt or exception to hook. -@param[in] ExceptionHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER that is called -when a processor interrupt occurs. If this parameter is NULL, then the handler -will be uninstalled. + @param[in] ExceptionType Defines which interrupt or exception to hook. + @param[in] ExceptionHandler A pointer to a function of type + EFI_CPU_INTERRUPT_HANDLER that is called when a + processor interrupt occurs. If this parameter is + NULL, then the handler will be uninstalled. -@retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled. -@retval EFI_ALREADY_STARTED ExceptionHandler is not NULL, and a handler for ExceptionType was -previously installed. -@retval EFI_INVALID_PARAMETER ExceptionHandler is NULL, and a handler for ExceptionType was not -previously installed. -@retval EFI_UNSUPPORTED The interrupt specified by ExceptionType is not supported, -or this function is not supported. + @retval EFI_SUCCESS The handler for the processor interrupt was + successfully installed or uninstalled. + @retval EFI_ALREADY_STARTED ExceptionHandler is not NULL, and a handler + for ExceptionType was previously installed. + @retval EFI_INVALID_PARAMETER ExceptionHandler is NULL, and a handler for + ExceptionType was not previously installed. + @retval EFI_UNSUPPORTED The interrupt specified by ExceptionType is not + supported, or this function is not supported. **/ RETURN_STATUS RegisterCpuInterruptHandler ( @@ -240,19 +253,19 @@ RegisterCpuInterruptHandler ( } /** -Register exception handler. + Register exception handler. -@param ExceptionType Defines which interrupt or exception to hook. Type EFI_EXCEPTION_TYPE and -the valid values for this parameter are defined in EFI_DEBUG_SUPPORT_PROTOCOL -of the UEFI 2.0 specification. -@param InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER -that is called when a processor interrupt occurs. -If this parameter is NULL, then the handler will be uninstalled. + @param ExceptionType Defines which interrupt or exception to hook. Type EFI_EXCEPTION_TYPE and + the valid values for this parameter are defined in EFI_DEBUG_SUPPORT_PROTOCOL + of the UEFI 2.0 specification. + @param InterruptHandler A pointer to a function of type EFI_CPU_INTERRUPT_HANDLER + that is called when a processor interrupt occurs. + If this parameter is NULL, then the handler will be uninstalled. -@retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled. -@retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was previously installed. -@retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not previously installed. -@retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported. + @retval EFI_SUCCESS The handler for the processor interrupt was successfully installed or uninstalled. + @retval EFI_ALREADY_STARTED InterruptHandler is not NULL, and a handler for InterruptType was previously installed. + @retval EFI_INVALID_PARAMETER InterruptHandler is NULL, and a handler for InterruptType was not previously installed. + @retval EFI_UNSUPPORTED The interrupt specified by InterruptType is not supported. **/ EFI_STATUS -- 2.30.2