From patchwork Wed Jun 22 20:23:54 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Alistair Francis X-Patchwork-Id: 639398 Return-Path: X-Original-To: incoming@patchwork.ozlabs.org Delivered-To: patchwork-incoming@bilbo.ozlabs.org Received: from lists.gnu.org (lists.gnu.org [IPv6:2001:4830:134:3::11]) (using TLSv1 with cipher AES256-SHA (256/256 bits)) (No client certificate requested) by ozlabs.org (Postfix) with ESMTPS id 3rZbnB1YdNz9t0S for ; Thu, 23 Jun 2016 06:30:06 +1000 (AEST) Received: from localhost ([::1]:60680 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bFomi-0006Fm-5H for incoming@patchwork.ozlabs.org; Wed, 22 Jun 2016 16:30:04 -0400 Received: from eggs.gnu.org ([2001:4830:134:3::10]:60839) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bFoh7-0008Na-0t for qemu-devel@nongnu.org; Wed, 22 Jun 2016 16:24:21 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1bFoh2-0003vk-OY for qemu-devel@nongnu.org; Wed, 22 Jun 2016 16:24:16 -0400 Received: from mail-sn1nam02on0041.outbound.protection.outlook.com ([104.47.36.41]:16726 helo=NAM02-SN1-obe.outbound.protection.outlook.com) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1bFoh2-0003ve-F1 for qemu-devel@nongnu.org; Wed, 22 Jun 2016 16:24:12 -0400 Received: from CY1NAM02FT015.eop-nam02.prod.protection.outlook.com (10.152.74.58) by CY1NAM02HT070.eop-nam02.prod.protection.outlook.com (10.152.75.227) with Microsoft SMTP Server (TLS) id 15.1.523.9; Wed, 22 Jun 2016 20:24:10 +0000 Authentication-Results: spf=fail (sender IP is 149.199.60.96) smtp.mailfrom=xilinx.com; linaro.org; dkim=none (message not signed) header.d=none; linaro.org; dmarc=none action=none header.from=xilinx.com; Received-SPF: Fail (protection.outlook.com: domain of xilinx.com does not designate 149.199.60.96 as permitted sender) receiver=protection.outlook.com; client-ip=149.199.60.96; helo=xsj-tvapsmtpgw01; Received: from xsj-tvapsmtpgw01 (149.199.60.96) by CY1NAM02FT015.mail.protection.outlook.com (10.152.75.146) with Microsoft SMTP Server (TLS) id 15.1.523.9 via Frontend Transport; Wed, 22 Jun 2016 20:24:09 +0000 Received: from 172-16-1-203.xilinx.com ([172.16.1.203]:56783 helo=xsj-tvapsmtp02.xilinx.com) by xsj-tvapsmtpgw01 with esmtp (Exim 4.63) (envelope-from ) id 1bFogz-000771-7g; Wed, 22 Jun 2016 13:24:09 -0700 Received: from [127.0.0.1] (port=37391 helo=tsj-smtp-dlp1.xlnx.xilinx.com) by xsj-tvapsmtp02.xilinx.com with esmtp (Exim 4.63) (envelope-from ) id 1bFogz-0004h6-4G; Wed, 22 Jun 2016 13:24:09 -0700 Received: from xsj-tvapsmtp02 (xsj-tvapsmtp02.xilinx.com [172.16.1.203]) by tsj-smtp-dlp1.xlnx.xilinx.com (8.13.8/8.13.1) with ESMTP id u5MKHbaL002071; Wed, 22 Jun 2016 13:17:37 -0700 Received: from [172.19.74.182] (port=37780 helo=xsjalistai50.xilinx.com) by xsj-tvapsmtp02 with esmtp (Exim 4.63) (envelope-from ) id 1bFogy-0004h3-7B; Wed, 22 Jun 2016 13:24:08 -0700 From: Alistair Francis To: , Date: Wed, 22 Jun 2016 13:23:54 -0700 Message-ID: <7d57d1d9d76bb4ac6c60b6509688e4589e5e9a95.1466626975.git.alistair.francis@xilinx.com> X-Mailer: git-send-email 2.7.4 In-Reply-To: References: X-RCIS-Action: ALLOW X-TM-AS-MML: disable X-TM-AS-Product-Ver: IMSS-7.1.0.1679-8.0.0.1202-22406.005 X-TM-AS-Result: No--7.341-7.0-31-10 X-imss-scan-details: No--7.341-7.0-31-10 X-TMASE-MatchedRID: 7NDqnukzTy3/uyguzMmOKARH1Nr7oERd+eBf9ovw8I1BDVeC8J7uwelz n2iMsMvuH+YDSJVIUsZlISHN0f/TWNrgdMxU+gJZFYJUGv4DL3xzd7C7BtJobpqVSxvNUw1V3V8 AphhLZjw7n0++/EjfVzNR3ESXGG1Bt/K29VNwEQWzI1v7J4hECgYX4TqbN42o7a71bENFnTO0IV JxcWBFKMQ23MLbrzZ8s3mmRrQMaogkCweBaYa3yDCaEJt46PppTJDl9FKHbrlFDR0AKGX+XOD0Y 64nEJOeIq9FWHS4IZb70Aj4svCBHB8TzIzimOwPC24oEZ6SpSkj80Za3RRg8FCt5nOVI2pzyiaG jt1DfDX5bQ9mY92/Yky6UMlm+3j67PVZyMZeYGc= X-EOPAttributedMessage: 0 X-Forefront-Antispam-Report: CIP:149.199.60.96; IPV:NLI; CTRY:US; EFV:NLI; SFV:NSPM; SFS:(10009020)(6009001)(7916002)(2980300002)(1110001)(1109001)(339900001)(189002)(199003)(7696003)(71366001)(5003600100003)(2950100001)(356003)(81156014)(8676002)(7846002)(81166006)(47776003)(77096005)(87936001)(64026002)(118296001)(189998001)(92566002)(305945005)(6806005)(50466002)(48376002)(5001770100001)(36756003)(8936002)(106466001)(105606002)(229853001)(50226002)(2906002)(19580395003)(19580405001)(33646002)(50986999)(76176999)(11100500001)(5003940100001)(586003)(86362001)(4326007)(85426001)(9786002)(107986001); DIR:OUT; SFP:1101; SCL:1; SRVR:CY1NAM02HT070; H:xsj-tvapsmtpgw01; FPR:; SPF:Fail; PTR:unknown-60-96.xilinx.com; MX:1; A:1; CAT:NONE; LANG:en; CAT:NONE; MIME-Version: 1.0 X-MS-Office365-Filtering-Correlation-Id: 712f89d8-95d6-4c2a-55f4-08d39adb2b28 X-Microsoft-Antispam: UriScan:;BCL:0;PCL:0;RULEID:;SRVR:CY1NAM02HT070; X-Microsoft-Antispam-PRVS: X-Exchange-Antispam-Report-Test: UriScan:(192813158149592); X-Exchange-Antispam-Report-CFA-Test: BCL:0; PCL:0; RULEID:(601004)(2401047)(13015025)(13017025)(13023025)(13018025)(13024025)(8121501046)(5005006)(10201501046)(3002001)(6055026); SRVR:CY1NAM02HT070; BCL:0; PCL:0; RULEID:; SRVR:CY1NAM02HT070; X-Forefront-PRVS: 0981815F2F X-OriginatorOrg: xilinx.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 22 Jun 2016 20:24:09.7419 (UTC) X-MS-Exchange-CrossTenant-Id: 657af505-d5df-48d0-8300-c31994686c5c X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=657af505-d5df-48d0-8300-c31994686c5c; Ip=[149.199.60.96]; Helo=[xsj-tvapsmtpgw01] X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: CY1NAM02HT070 X-detected-operating-system: by eggs.gnu.org: Windows 7 or 8 [fuzzy] X-Received-From: 104.47.36.41 Subject: [Qemu-devel] [PATCH v7 04/12] register: Define REG and FIELD macros X-BeenThere: qemu-devel@nongnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Cc: edgar.iglesias@xilinx.com, alistair.francis@xilinx.com, crosthwaitepeter@gmail.com, edgar.iglesias@gmail.com, alex.bennee@linaro.org, afaerber@suse.de, fred.konrad@greensocs.com Errors-To: qemu-devel-bounces+incoming=patchwork.ozlabs.org@nongnu.org Sender: "Qemu-devel" From: Peter Crosthwaite Define some macros that can be used for defining registers and fields. The REG32 macro will define A_FOO, for the byte address of a register as well as R_FOO for the uint32_t[] register number (A_FOO / 4). The FIELD macro will define FOO_BAR_MASK, FOO_BAR_SHIFT and FOO_BAR_LENGTH constants for field BAR in register FOO. Finally, there are some shorthand helpers for extracting/depositing fields from registers based on these naming schemes. Usage can greatly reduce the verbosity of device code. The deposit and extract macros (eg FIELD_EX32, FIELD_DP32 etc.) can be used to generate extract and deposits without any repetition of the name stems. Signed-off-by: Peter Crosthwaite [ EI Changes: * Add Deposit macros ] Signed-off-by: Edgar E. Iglesias Signed-off-by: Alistair Francis Reviewed-by: Peter Maydell --- E.g. Currently you have to define something like: \#define R_FOOREG (0x84/4) \#define R_FOOREG_BARFIELD_SHIFT 10 \#define R_FOOREG_BARFIELD_LENGTH 5 uint32_t foobar_val = extract32(s->regs[R_FOOREG], R_FOOREG_BARFIELD_SHIFT, R_FOOREG_BARFIELD_LENGTH); Which has: 2 macro definitions per field 3 register names ("FOOREG") per extract 2 field names ("BARFIELD") per extract With these macros this becomes: REG32(FOOREG, 0x84) FIELD(FOOREG, BARFIELD, 10, 5) uint32_t foobar_val = ARRAY_FIELD_EX32(s->regs, FOOREG, BARFIELD) Which has: 1 macro definition per field 1 register name per extract 1 field name per extract If you are not using arrays for the register data you can just use the non-array "FIELD_" variants and still save 2 name stems: uint32_t foobar_val = FIELD_EX32(s->fooreg, FOOREG, BARFIELD) Deposit is similar for depositing values. Deposit has compile-time overflow checking for literals. For example: REG32(XYZ1, 0x84) FIELD(XYZ1, TRC, 0, 4) /* Correctly set XYZ1.TRC = 5. */ ARRAY_FIELD_DP32(s->regs, XYZ1, TRC, 5); /* Incorrectly set XYZ1.TRC = 16. */ ARRAY_FIELD_DP32(s->regs, XYZ1, TRC, 16); The latter assignment results in: warning: large integer implicitly truncated to unsigned type [-Woverflow] include/hw/register.h | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/include/hw/register.h b/include/hw/register.h index e160150..216b679 100644 --- a/include/hw/register.h +++ b/include/hw/register.h @@ -150,4 +150,47 @@ void register_write_memory(void *opaque, hwaddr addr, uint64_t value, uint64_t register_read_memory(void *opaque, hwaddr addr, unsigned size); +/* Define constants for a 32 bit register */ + +/* This macro will define A_FOO, for the byte address of a register + * as well as R_FOO for the uint32_t[] register number (A_FOO / 4). + */ +#define REG32(reg, addr) \ + enum { A_ ## reg = (addr) }; \ + enum { R_ ## reg = (addr) / 4 }; + +/* Define SHIFT, LEGTH and MASK constants for a field within a register */ + +/* This macro will define FOO_BAR_MASK, FOO_BAR_SHIFT and FOO_BAR_LENGTH + * constants for field BAR in register FOO. + */ +#define FIELD(reg, field, shift, length) \ + enum { R_ ## reg ## _ ## field ## _SHIFT = (shift)}; \ + enum { R_ ## reg ## _ ## field ## _LENGTH = (length)}; \ + enum { R_ ## reg ## _ ## field ## _MASK = \ + MAKE_64BIT_MASK(shift, length); + +/* Extract a field from a register */ +#define FIELD_EX32(storage, reg, field) \ + extract32((storage), R_ ## reg ## _ ## field ## _SHIFT, \ + R_ ## reg ## _ ## field ## _LENGTH) + +/* Extract a field from an array of registers */ +#define ARRAY_FIELD_EX32(regs, reg, field) \ + FIELD_EX32((regs)[R_ ## reg], reg, field) + +/* Deposit a register field. */ +#define FIELD_DP32(storage, reg, field, val) ({ \ + struct { \ + unsigned int v:R_ ## reg ## _ ## field ## _LENGTH; \ + } v = { .v = val }; \ + uint32_t d; \ + d = deposit32((storage), R_ ## reg ## _ ## field ## _SHIFT, \ + R_ ## reg ## _ ## field ## _LENGTH, v.v); \ + d; }) + +/* Deposit a field to array of registers. */ +#define ARRAY_FIELD_DP32(regs, reg, field, val) \ + (regs)[R_ ## reg] = FIELD_DP32((regs)[R_ ## reg], reg, field, val); + #endif