From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from mx0a-0031df01.pphosted.com (mx0a-0031df01.pphosted.com [205.220.168.131]) by mx.groups.io with SMTP id smtpd.web12.15390.1664306149772706909 for ; Tue, 27 Sep 2022 12:15:49 -0700 Authentication-Results: mx.groups.io; dkim=pass header.i=@quicinc.com header.s=qcppdkim1 header.b=RevW67tP; 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.168.131, mailfrom: quic_rcran@quicinc.com) Received: from pps.filterd (m0279864.ppops.net [127.0.0.1]) by mx0a-0031df01.pphosted.com (8.17.1.5/8.17.1.5) with ESMTP id 28RG78m7016531; Tue, 27 Sep 2022 19:15:37 GMT DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=quicinc.com; h=message-id : date : mime-version : subject : to : cc : references : from : in-reply-to : content-type : content-transfer-encoding; s=qcppdkim1; bh=d/53H+OCA9vQJ4qeHnDrp7K5GJm/A594owkgBYtMVJ8=; b=RevW67tP2z/2mDEuKi/khwKZcCrXD3wSRerbiXb+6+1KX7LfOq1ueu8UZs2GuWSG2xJn WDkZkYMd/JtajQZGCBChRrJfP4BTKT8ncUpiIMsg/M0CTo7FngYifQsRb0J+BRJcEQNC 5EvkYBomkHd/WoMLLwV22lAbD5iFVfoPw/mKFAb7nRgYkPUImyBJGm0Qmtt/ch1jFSh+ aLdH/PZf968+bGfFOnTzhlj2AlkPRodWkCJaucwBh7zOhqv+e3WvQDndJt32PQwxnb+Z Hya0IbTLHB+b+rirldkAplpro2s1vcdrcXeRKN5m959v7I5USB1+Lzb9FP/QYwCZPO3m CA== Received: from nalasppmta02.qualcomm.com (Global_NAT1.qualcomm.com [129.46.96.20]) by mx0a-0031df01.pphosted.com (PPS) with ESMTPS id 3jupssu83t-1 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 27 Sep 2022 19:15:37 +0000 Received: from nalasex01a.na.qualcomm.com (nalasex01a.na.qualcomm.com [10.47.209.196]) by NALASPPMTA02.qualcomm.com (8.17.1.5/8.17.1.5) with ESMTPS id 28RJAavg017257 (version=TLSv1.2 cipher=ECDHE-RSA-AES256-GCM-SHA384 bits=256 verify=NOT); Tue, 27 Sep 2022 19:10:36 GMT Received: from [10.110.5.18] (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.29; Tue, 27 Sep 2022 12:10:35 -0700 Message-ID: <7ab9ddab-afb1-d950-7f67-21d928e3962f@quicinc.com> Date: Tue, 27 Sep 2022 12:10:34 -0700 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:102.0) Gecko/20100101 Thunderbird/102.1.2 Subject: Re: [edk2-devel] [PATCH v5 03/21] ArmPkg/ArmMonitorLib: Add ArmMonitorLib To: , CC: Sami Mujawar , Leif Lindholm , Ard Biesheuvel , Rebecca Cran , Michael D Kinney , Liming Gao , "Jiewen Yao" , Jian J Wang References: <20220919192207.637786-1-Pierre.Gondois@arm.com> <20220919192207.637786-4-Pierre.Gondois@arm.com> From: "Rebecca Cran" In-Reply-To: <20220919192207.637786-4-Pierre.Gondois@arm.com> 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-GUID: jHIhcB_EQcT46HrbL1VIFqfL2LJ3yzA- X-Proofpoint-ORIG-GUID: jHIhcB_EQcT46HrbL1VIFqfL2LJ3yzA- X-Proofpoint-Virus-Version: vendor=baseguard engine=ICAP:2.0.205,Aquarius:18.0.895,Hydra:6.0.528,FMLib:17.11.122.1 definitions=2022-09-27_09,2022-09-27_01,2022-06-22_01 X-Proofpoint-Spam-Details: rule=outbound_notspam policy=outbound score=0 clxscore=1015 priorityscore=1501 mlxscore=0 malwarescore=0 bulkscore=0 mlxlogscore=886 phishscore=0 adultscore=0 impostorscore=0 spamscore=0 suspectscore=0 lowpriorityscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=8.12.0-2209130000 definitions=main-2209270121 Content-Language: en-US Content-Type: text/plain; charset="UTF-8"; format=flowed Content-Transfer-Encoding: 7bit On 9/19/2022 12:21 PM, PierreGondois wrote: > +/** Monitor call. > + > + An HyperVisor Call (HVC) or System Monitor Call (SMC) will be issued > + depending on the default conduit. PcdMonitorConduitHvc determines the type > + of the call: if true, do an HVC. > + > + @param [in, out] Args Arguments for the HVC/SMC. > +**/ > +VOID > +EFIAPI > +ArmMonitorCall ( > + IN OUT ARM_MONITOR_ARGS *Args > + ) Doxygen specifies that there shouldn't be a space between "in" and "out" From https://doxygen.nl/manual/docblocks.html "For functions one can use the @param command to document the parameters and then use [in], [out], [in,out] to document the direction." Clang can warn about this mismatch when the various documentation commands are used: https://clang.llvm.org/docs/DiagnosticsReference.html -- Rebecca Cran