arm_adi_v5: add ap refcount and add get/put around ap use

While an ADIv5 DAP can only have 256 AP, ADIv6 can provide till
2**40 (1,099,511,627,776) AP per DAP.
The actual trivial code implementation for ADIv5 (that uses an
array of 256 ap in the struct adiv5_dap) cannot be extended as-is
to handle ADIv6.

The simple array of 256 AP can be reused as a dynamic storage for
ADIv6 ap:
- the ADIv5 AP number is replaced by the ADIv6 base address;
- the index of the array (equal to ADIv5 AP number) has no link to
  any ADIv6 property;
- the ADIv6 base_address has to be searched in the array of AP.

The 256 elements in the AP array should be enough for any device
available today. In future it can be easily increased, if needed.

To efficiently use the 256 elements in the AP array, the code
should associate one element of the array to an ADIv6 AP (through
the AP base address), then cancel the association when the AP is
not anymore needed. This is important to avoid saturating the AP
array while exploring the device through 'dap apreg' commands.

Add a reference counter in the struct adiv5_ap to track how many
times the struct has been associated with the same base address.
Introduce the function dap_get_ap() to associate and return the
struct, and dap_put_ap() to release the struct. For the moment the
code covers ADIv5 only, so the association is through the index.
Use the two functions above and dap_find_get_ap() throughout the
code.
Check the return value of dap_get_ap(). It is always not NULL in
the current ADIv5-only implementation, but can be NULL for ADIv6
when there are no more available AP in the array.
Instrument dap_queue_ap_read() and dap_queue_ap_write() to log an
error message if the AP has reference counter zero, meaning that
the AP has not been 'get' yet. This helps identifying AP used
without get/put, e.g. code missed by this patch, or merged later.
Instrument dap_cleanup_all() to log an error message if an AP has
reference counter not zero at openocd exit, meaning that the AP
has not been 'put' yet.

Change-Id: I98316eb42b9f3d9c9bbbb6c73b1091b53f629092
Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com>
Reviewed-on: https://review.openocd.org/c/openocd/+/6455
Reviewed-by: Daniel Goehring <dgoehrin@os.amperecomputing.com>
Tested-by: jenkins

1 files changed, 15 insertions, 11 deletions

diff --git a/src/target/arm_cti.c b/src/target/arm_cti.c
index 96927bf..74388ae 100644
--- a/src/target/arm_cti.c
+++ b/src/target/arm_cti.c
@@ -34,6 +34,7 @@ struct arm_cti {
 	struct list_head lh;
 	char *name;
 	struct adiv5_mem_ap_spot spot;
+	struct adiv5_ap *ap;
 };
 
 static LIST_HEAD(all_cti);
@@ -65,7 +66,7 @@ struct arm_cti *cti_instance_by_jim_obj(Jim_Interp *interp, Jim_Obj *o)
 
 static int arm_cti_mod_reg_bits(struct arm_cti *self, unsigned int reg, uint32_t mask, uint32_t value)
 {
-	struct adiv5_ap *ap = dap_ap(self->spot.dap, self->spot.ap_num);
+	struct adiv5_ap *ap = self->ap;
 	uint32_t tmp;
 
 	/* Read register */
@@ -84,15 +85,14 @@ static int arm_cti_mod_reg_bits(struct arm_cti *self, unsigned int reg, uint32_t
 
 int arm_cti_enable(struct arm_cti *self, bool enable)
 {
-	struct adiv5_ap *ap = dap_ap(self->spot.dap, self->spot.ap_num);
 	uint32_t val = enable ? 1 : 0;
 
-	return mem_ap_write_atomic_u32(ap, self->spot.base + CTI_CTR, val);
+	return mem_ap_write_atomic_u32(self->ap, self->spot.base + CTI_CTR, val);
 }
 
 int arm_cti_ack_events(struct arm_cti *self, uint32_t event)
 {
-	struct adiv5_ap *ap = dap_ap(self->spot.dap, self->spot.ap_num);
+	struct adiv5_ap *ap = self->ap;
 	int retval;
 	uint32_t tmp;
 
@@ -134,19 +134,15 @@ int arm_cti_ungate_channel(struct arm_cti *self, uint32_t channel)
 
 int arm_cti_write_reg(struct arm_cti *self, unsigned int reg, uint32_t value)
 {
-	struct adiv5_ap *ap = dap_ap(self->spot.dap, self->spot.ap_num);
-
-	return mem_ap_write_atomic_u32(ap, self->spot.base + reg, value);
+	return mem_ap_write_atomic_u32(self->ap, self->spot.base + reg, value);
 }
 
 int arm_cti_read_reg(struct arm_cti *self, unsigned int reg, uint32_t *p_value)
 {
-	struct adiv5_ap *ap = dap_ap(self->spot.dap, self->spot.ap_num);
-
 	if (!p_value)
 		return ERROR_COMMAND_ARGUMENT_INVALID;
 
-	return mem_ap_read_atomic_u32(ap, self->spot.base + reg, p_value);
+	return mem_ap_read_atomic_u32(self->ap, self->spot.base + reg, p_value);
 }
 
 int arm_cti_pulse_channel(struct arm_cti *self, uint32_t channel)
@@ -228,6 +224,8 @@ int arm_cti_cleanup_all(void)
 	struct arm_cti *obj, *tmp;
 
 	list_for_each_entry_safe(obj, tmp, &all_cti, lh) {
+		if (obj->ap)
+			dap_put_ap(obj->ap);
 		free(obj->name);
 		free(obj);
 	}
@@ -238,7 +236,7 @@ int arm_cti_cleanup_all(void)
 COMMAND_HANDLER(handle_cti_dump)
 {
 	struct arm_cti *cti = CMD_DATA;
-	struct adiv5_ap *ap = dap_ap(cti->spot.dap, cti->spot.ap_num);
+	struct adiv5_ap *ap = cti->ap;
 	int retval = ERROR_OK;
 
 	for (int i = 0; (retval == ERROR_OK) && (i < (int)ARRAY_SIZE(cti_names)); i++)
@@ -518,6 +516,12 @@ static int cti_create(struct jim_getopt_info *goi)
 
 	list_add_tail(&cti->lh, &all_cti);
 
+	cti->ap = dap_get_ap(cti->spot.dap, cti->spot.ap_num);
+	if (!cti->ap) {
+		Jim_SetResultString(goi->interp, "Cannot get AP", -1);
+		return JIM_ERR;
+	}
+
 	return JIM_OK;
 }