config: convert 'pi_integral_scale' to the new scheme.

Signed-off-by: Richard Cochran <richardcochran@gmail.com>

config.c

@@ -97,6 +97,7 @@ struct config_item config_tab[] = {
 	GLOB_ITEM_INT("logging_level", LOG_INFO, PRINT_LEVEL_MIN, PRINT_LEVEL_MAX),
 	GLOB_ITEM_INT("max_frequency", 900000000, 0, INT_MAX),
 	GLOB_ITEM_DBL("pi_integral_const", 0.0, 0.0, DBL_MAX),
+	GLOB_ITEM_DBL("pi_integral_scale", 0.0, 0.0, DBL_MAX),
 	GLOB_ITEM_DBL("pi_proportional_const", 0.0, 0.0, DBL_MAX),
 	GLOB_ITEM_DBL("pi_proportional_exponent", -0.3, -DBL_MAX, DBL_MAX),
 	GLOB_ITEM_DBL("pi_proportional_norm_max", 0.7, DBL_MIN, 1.0),
@@ -546,12 +547,6 @@ static enum parser_result parse_global_setting(const char *option,
 		cfg->dds.freq_est_interval = val;
 		pod->freq_est_interval = val;
 
-	} else if (!strcmp(option, "pi_integral_scale")) {
-		r = get_ranged_double(value, &df, 0.0, DBL_MAX);
-		if (r != PARSED_OK)
-			return r;
-		*cfg->pi_integral_scale = df;
-
 	} else if (!strcmp(option, "pi_integral_exponent")) {
 		r = get_ranged_double(value, &df, -DBL_MAX, DBL_MAX);
 		if (r != PARSED_OK)

config.h

@@ -69,7 +69,6 @@ struct config {
 	struct port_defaults pod;
 	enum servo_type clock_servo;
 
-	double *pi_integral_scale;
 	double *pi_integral_exponent;
 	double *pi_integral_norm_max;
 	int *ntpshm_segment;

pi.c

@@ -36,7 +36,6 @@
 #define FREQ_EST_MARGIN 0.001
 
 /* These take their values from the configuration file. (see ptp4l.c) */
-double configured_pi_ki_scale = 0.0;
 double configured_pi_ki_exponent = 0.4;
 double configured_pi_ki_norm_max = 0.3;
 
@@ -55,6 +54,7 @@ struct pi_servo {
 	double configured_pi_kp_scale;
 	double configured_pi_kp_exponent;
 	double configured_pi_kp_norm_max;
+	double configured_pi_ki_scale;
 };
 
 static void pi_destroy(struct servo *servo)
@@ -164,7 +164,7 @@ static void pi_sync_interval(struct servo *servo, double interval)
 	if (s->kp > s->configured_pi_kp_norm_max / interval)
 		s->kp = s->configured_pi_kp_norm_max / interval;
 
-	s->ki = configured_pi_ki_scale * pow(interval, configured_pi_ki_exponent);
+	s->ki = s->configured_pi_ki_scale * pow(interval, configured_pi_ki_exponent);
 	if (s->ki > configured_pi_ki_norm_max / interval)
 		s->ki = configured_pi_ki_norm_max / interval;
 
@@ -202,24 +202,26 @@ struct servo *pi_servo_create(struct config *cfg, int fadj, int sw_ts)
 		config_get_double(cfg, NULL, "pi_proportional_exponent");
 	s->configured_pi_kp_norm_max =
 		config_get_double(cfg, NULL, "pi_proportional_norm_max");
+	s->configured_pi_ki_scale =
+		config_get_double(cfg, NULL, "pi_integral_scale");
 
 	if (s->configured_pi_kp && s->configured_pi_ki) {
 		/* Use the constants as configured by the user without
 		   adjusting for sync interval unless they make the servo
 		   unstable. */
 		s->configured_pi_kp_scale = s->configured_pi_kp;
-		configured_pi_ki_scale = s->configured_pi_ki;
+		s->configured_pi_ki_scale = s->configured_pi_ki;
 		s->configured_pi_kp_exponent = 0.0;
 		configured_pi_ki_exponent = 0.0;
 		s->configured_pi_kp_norm_max = MAX_KP_NORM_MAX;
 		configured_pi_ki_norm_max = MAX_KI_NORM_MAX;
-	} else if (!s->configured_pi_kp_scale || !configured_pi_ki_scale) {
+	} else if (!s->configured_pi_kp_scale || !s->configured_pi_ki_scale) {
 		if (sw_ts) {
 			s->configured_pi_kp_scale = SWTS_KP_SCALE;
-			configured_pi_ki_scale = SWTS_KI_SCALE;
+			s->configured_pi_ki_scale = SWTS_KI_SCALE;
 		} else {
 			s->configured_pi_kp_scale = HWTS_KP_SCALE;
-			configured_pi_ki_scale = HWTS_KI_SCALE;
+			s->configured_pi_ki_scale = HWTS_KI_SCALE;
 		}
 	}
 

pi.h

@@ -21,14 +21,6 @@
 
 #include "servo.h"
 
-/**
- * When set to a non-zero value, this variable determines the scale in the
- * formula used to set the integral constant of the PI controller from the
- * sync interval.
- * ki = min(ki_scale * sync^ki_exponent, ki_norm_max / sync)
- */
-extern double configured_pi_ki_scale;
-
 /**
  * This variable determines the exponent in the formula used to set the
  * integral constant of the PI controller from the sync interval.

ptp4l.c

@@ -103,7 +103,6 @@ static struct config cfg_settings = {
 	.transport = TRANS_UDP_IPV4,
 	.clock_servo = CLOCK_SERVO_PI,
 
-	.pi_integral_scale = &configured_pi_ki_scale,
 	.pi_integral_exponent = &configured_pi_ki_exponent,
 	.pi_integral_norm_max = &configured_pi_ki_norm_max,
 	.ntpshm_segment = &ntpshm_segment,