power: fix P-state base frequency handling
[dpdk.git] / lib / librte_power / power_pstate_cpufreq.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2018 Intel Corporation
3  */
4
5 #include <stdio.h>
6 #include <sys/types.h>
7 #include <sys/stat.h>
8 #include <fcntl.h>
9 #include <stdlib.h>
10 #include <string.h>
11 #include <unistd.h>
12 #include <signal.h>
13 #include <limits.h>
14 #include <errno.h>
15 #include <inttypes.h>
16
17 #include <rte_memcpy.h>
18 #include <rte_memory.h>
19 #include <rte_string_fns.h>
20
21 #include "power_pstate_cpufreq.h"
22 #include "power_common.h"
23
24
25 #ifdef RTE_LIBRTE_POWER_DEBUG
26 #define POWER_DEBUG_TRACE(fmt, args...) do { \
27                 RTE_LOG(ERR, POWER, "%s: " fmt, __func__, ## args); \
28 } while (0)
29 #else
30 #define POWER_DEBUG_TRACE(fmt, args...)
31 #endif
32
33 #define FOPEN_OR_ERR_RET(f, retval) do { \
34                 if ((f) == NULL) { \
35                         RTE_LOG(ERR, POWER, "File not opened\n"); \
36                         return retval; \
37                 } \
38 } while (0)
39
40 #define FOPS_OR_NULL_GOTO(ret, label) do { \
41                 if ((ret) == NULL) { \
42                         RTE_LOG(ERR, POWER, "fgets returns nothing\n"); \
43                         goto label; \
44                 } \
45 } while (0)
46
47 #define FOPS_OR_ERR_GOTO(ret, label) do { \
48                 if ((ret) < 0) { \
49                         RTE_LOG(ERR, POWER, "File operations failed\n"); \
50                         goto label; \
51                 } \
52 } while (0)
53
54 /* macros used for rounding frequency to nearest 100000 */
55 #define FREQ_ROUNDING_DELTA 50000
56 #define ROUND_FREQ_TO_N_100000 100000
57
58 #define POWER_CONVERT_TO_DECIMAL 10
59 #define BUS_FREQ     100000
60
61 #define POWER_GOVERNOR_PERF "performance"
62 #define POWER_SYSFILE_GOVERNOR  \
63                 "/sys/devices/system/cpu/cpu%u/cpufreq/scaling_governor"
64 #define POWER_SYSFILE_MAX_FREQ \
65                 "/sys/devices/system/cpu/cpu%u/cpufreq/scaling_max_freq"
66 #define POWER_SYSFILE_MIN_FREQ  \
67                 "/sys/devices/system/cpu/cpu%u/cpufreq/scaling_min_freq"
68 #define POWER_SYSFILE_CUR_FREQ  \
69                 "/sys/devices/system/cpu/cpu%u/cpufreq/scaling_cur_freq"
70 #define POWER_SYSFILE_BASE_MAX_FREQ \
71                 "/sys/devices/system/cpu/cpu%u/cpufreq/cpuinfo_max_freq"
72 #define POWER_SYSFILE_BASE_MIN_FREQ  \
73                 "/sys/devices/system/cpu/cpu%u/cpufreq/cpuinfo_min_freq"
74 #define POWER_SYSFILE_BASE_FREQ  \
75                 "/sys/devices/system/cpu/cpu%u/cpufreq/base_frequency"
76 #define POWER_PSTATE_DRIVER "intel_pstate"
77 #define POWER_MSR_PATH  "/dev/cpu/%u/msr"
78
79 /*
80  * MSR related
81  */
82 #define PLATFORM_INFO     0x0CE
83 #define NON_TURBO_MASK    0xFF00
84 #define NON_TURBO_OFFSET  0x8
85
86
87 enum power_state {
88         POWER_IDLE = 0,
89         POWER_ONGOING,
90         POWER_USED,
91         POWER_UNKNOWN
92 };
93
94 struct pstate_power_info {
95         unsigned int lcore_id;               /**< Logical core id */
96         uint32_t freqs[RTE_MAX_LCORE_FREQS]; /**< Frequency array */
97         uint32_t nb_freqs;                   /**< number of available freqs */
98         FILE *f_cur_min;                     /**< FD of scaling_min */
99         FILE *f_cur_max;                     /**< FD of scaling_max */
100         char governor_ori[32];               /**< Original governor name */
101         uint32_t curr_idx;                   /**< Freq index in freqs array */
102         uint32_t non_turbo_max_ratio;        /**< Non Turbo Max ratio  */
103         uint32_t sys_max_freq;               /**< system wide max freq  */
104         uint32_t core_base_freq;             /**< core base freq  */
105         uint32_t state;                      /**< Power in use state */
106         uint16_t turbo_available;            /**< Turbo Boost available */
107         uint16_t turbo_enable;               /**< Turbo Boost enable/disable */
108         uint16_t priority_core;              /**< High Performance core */
109 } __rte_cache_aligned;
110
111
112 static struct pstate_power_info lcore_power_info[RTE_MAX_LCORE];
113
114 /**
115  * It is to read the specific MSR.
116  */
117
118 static int32_t
119 power_rdmsr(int msr, uint64_t *val, unsigned int lcore_id)
120 {
121         int fd, ret;
122         char fullpath[PATH_MAX];
123
124         snprintf(fullpath, sizeof(fullpath), POWER_MSR_PATH, lcore_id);
125
126         fd = open(fullpath, O_RDONLY);
127
128         if (fd < 0) {
129                 RTE_LOG(ERR, POWER, "Error opening '%s': %s\n", fullpath,
130                                  strerror(errno));
131                 return fd;
132         }
133
134         ret = pread(fd, val, sizeof(uint64_t), msr);
135
136         if (ret < 0) {
137                 RTE_LOG(ERR, POWER, "Error reading '%s': %s\n", fullpath,
138                                  strerror(errno));
139                 goto out;
140         }
141
142         POWER_DEBUG_TRACE("MSR Path %s, offset 0x%X for lcore %u\n",
143                         fullpath, msr, lcore_id);
144
145         POWER_DEBUG_TRACE("Ret value %d, content is 0x%"PRIx64"\n", ret, *val);
146
147 out:    close(fd);
148         return ret;
149 }
150
151 /**
152  * It is to fopen the sys file for the future setting the lcore frequency.
153  */
154 static int
155 power_init_for_setting_freq(struct pstate_power_info *pi)
156 {
157         FILE *f_min, *f_max, *f_base = NULL, *f_base_max;
158         char fullpath_min[PATH_MAX];
159         char fullpath_max[PATH_MAX];
160         char fullpath_base[PATH_MAX];
161         char fullpath_base_max[PATH_MAX];
162         char buf_base[BUFSIZ];
163         char *s_base;
164         char *s_base_max;
165         uint32_t base_ratio = 0;
166         uint32_t base_max_ratio = 0;
167         uint64_t max_non_turbo = 0;
168         int  ret_val = 0;
169
170         snprintf(fullpath_base_max,
171                         sizeof(fullpath_base_max),
172                         POWER_SYSFILE_BASE_MAX_FREQ,
173                         pi->lcore_id);
174         f_base_max = fopen(fullpath_base_max, "r");
175         FOPEN_OR_ERR_RET(f_base_max, -1);
176         if (f_base_max != NULL) {
177                 s_base_max = fgets(buf_base, sizeof(buf_base), f_base_max);
178                 FOPS_OR_NULL_GOTO(s_base_max, out);
179
180                 buf_base[BUFSIZ-1] = '\0';
181                 if (strlen(buf_base))
182                         /* Strip off terminating '\n' */
183                         strtok(buf_base, "\n");
184
185                 base_max_ratio =
186                         strtoul(buf_base, NULL, POWER_CONVERT_TO_DECIMAL)
187                                 / BUS_FREQ;
188         }
189
190         snprintf(fullpath_min, sizeof(fullpath_min), POWER_SYSFILE_MIN_FREQ,
191                         pi->lcore_id);
192         f_min = fopen(fullpath_min, "rw+");
193         FOPEN_OR_ERR_RET(f_min, -1);
194
195         snprintf(fullpath_max, sizeof(fullpath_max), POWER_SYSFILE_MAX_FREQ,
196                         pi->lcore_id);
197         f_max = fopen(fullpath_max, "rw+");
198         if (f_max == NULL)
199                 fclose(f_min);
200         FOPEN_OR_ERR_RET(f_max, -1);
201
202         pi->f_cur_min = f_min;
203         pi->f_cur_max = f_max;
204
205         snprintf(fullpath_base, sizeof(fullpath_base), POWER_SYSFILE_BASE_FREQ,
206                         pi->lcore_id);
207
208         f_base = fopen(fullpath_base, "r");
209         if (f_base == NULL) {
210                 /* No sysfs base_frequency, that's OK, continue without */
211                 base_ratio = 0;
212         } else {
213                 s_base = fgets(buf_base, sizeof(buf_base), f_base);
214                 FOPS_OR_NULL_GOTO(s_base, out);
215
216                 buf_base[BUFSIZ-1] = '\0';
217                 if (strlen(buf_base))
218                         /* Strip off terminating '\n' */
219                         strtok(buf_base, "\n");
220
221                 base_ratio = strtoul(buf_base, NULL, POWER_CONVERT_TO_DECIMAL)
222                                 / BUS_FREQ;
223                 fclose(f_base);
224         }
225
226         /* Add MSR read to detect turbo status */
227
228         if (power_rdmsr(PLATFORM_INFO, &max_non_turbo, pi->lcore_id) < 0) {
229                 ret_val = -1;
230                 goto out;
231         }
232
233         max_non_turbo = (max_non_turbo&NON_TURBO_MASK)>>NON_TURBO_OFFSET;
234
235         POWER_DEBUG_TRACE("no turbo perf %"PRIu64"\n", max_non_turbo);
236
237         pi->non_turbo_max_ratio = max_non_turbo;
238
239         /*
240          * If base_frequency is reported as greater than the maximum
241          * turbo frequency, that's a known issue with some kernels.
242          * Set base_frequency to max_non_turbo as a workaround.
243          */
244         if (base_ratio > base_max_ratio) {
245                 /* base_ratio is greater than max turbo. Kernel bug. */
246                 pi->priority_core = 0;
247                 goto out;
248         }
249
250         /*
251          * If base_frequency is reported as greater than the maximum
252          * non-turbo frequency, then mark it as a high priority core.
253          */
254         if (base_ratio > max_non_turbo)
255                 pi->priority_core = 1;
256         else
257                 pi->priority_core = 0;
258         pi->core_base_freq = base_ratio * BUS_FREQ;
259
260 out:
261         if (f_base != NULL)
262                 fclose(f_base);
263         return ret_val;
264 }
265
266 static int
267 set_freq_internal(struct pstate_power_info *pi, uint32_t idx)
268 {
269         uint32_t target_freq = 0;
270
271         if (idx >= RTE_MAX_LCORE_FREQS || idx >= pi->nb_freqs) {
272                 RTE_LOG(ERR, POWER, "Invalid frequency index %u, which "
273                                 "should be less than %u\n", idx, pi->nb_freqs);
274                 return -1;
275         }
276
277         /* Check if it is the same as current */
278         if (idx == pi->curr_idx)
279                 return 0;
280
281         /* Because Intel Pstate Driver only allow user change min/max hint
282          * User need change the min/max as same value.
283          */
284         if (fseek(pi->f_cur_min, 0, SEEK_SET) < 0) {
285                 RTE_LOG(ERR, POWER, "Fail to set file position indicator to 0 "
286                                 "for setting frequency for lcore %u\n",
287                                 pi->lcore_id);
288                 return -1;
289         }
290
291         if (fseek(pi->f_cur_max, 0, SEEK_SET) < 0) {
292                 RTE_LOG(ERR, POWER, "Fail to set file position indicator to 0 "
293                                 "for setting frequency for lcore %u\n",
294                                 pi->lcore_id);
295                 return -1;
296         }
297
298         /* Turbo is available and enabled, first freq bucket is sys max freq */
299         if (pi->turbo_available && idx == 0) {
300                 if (pi->turbo_enable)
301                         target_freq = pi->sys_max_freq;
302                 else {
303                         RTE_LOG(ERR, POWER, "Turbo is off, frequency can't be scaled up more %u\n",
304                                         pi->lcore_id);
305                         return -1;
306                 }
307         } else
308                 target_freq = pi->freqs[idx];
309
310         /* Decrease freq, the min freq should be updated first */
311         if (idx  >  pi->curr_idx) {
312
313                 if (fprintf(pi->f_cur_min, "%u", target_freq) < 0) {
314                         RTE_LOG(ERR, POWER, "Fail to write new frequency for "
315                                         "lcore %u\n", pi->lcore_id);
316                         return -1;
317                 }
318
319                 if (fprintf(pi->f_cur_max, "%u", target_freq) < 0) {
320                         RTE_LOG(ERR, POWER, "Fail to write new frequency for "
321                                         "lcore %u\n", pi->lcore_id);
322                         return -1;
323                 }
324
325                 POWER_DEBUG_TRACE("Frequency '%u' to be set for lcore %u\n",
326                                   target_freq, pi->lcore_id);
327
328                 fflush(pi->f_cur_min);
329                 fflush(pi->f_cur_max);
330
331         }
332
333         /* Increase freq, the max freq should be updated first */
334         if (idx  <  pi->curr_idx) {
335
336                 if (fprintf(pi->f_cur_max, "%u", target_freq) < 0) {
337                         RTE_LOG(ERR, POWER, "Fail to write new frequency for "
338                                         "lcore %u\n", pi->lcore_id);
339                         return -1;
340                 }
341
342                 if (fprintf(pi->f_cur_min, "%u", target_freq) < 0) {
343                         RTE_LOG(ERR, POWER, "Fail to write new frequency for "
344                                         "lcore %u\n", pi->lcore_id);
345                         return -1;
346                 }
347
348                 POWER_DEBUG_TRACE("Frequency '%u' to be set for lcore %u\n",
349                                   target_freq, pi->lcore_id);
350
351                 fflush(pi->f_cur_max);
352                 fflush(pi->f_cur_min);
353         }
354
355         pi->curr_idx = idx;
356
357         return 1;
358 }
359
360 /**
361  * It is to check the current scaling governor by reading sys file, and then
362  * set it into 'performance' if it is not by writing the sys file. The original
363  * governor will be saved for rolling back.
364  */
365 static int
366 power_set_governor_performance(struct pstate_power_info *pi)
367 {
368         FILE *f;
369         int ret = -1;
370         char buf[BUFSIZ];
371         char fullpath[PATH_MAX];
372         char *s;
373         int val;
374
375         snprintf(fullpath, sizeof(fullpath), POWER_SYSFILE_GOVERNOR,
376                         pi->lcore_id);
377         f = fopen(fullpath, "rw+");
378         FOPEN_OR_ERR_RET(f, ret);
379
380         s = fgets(buf, sizeof(buf), f);
381         FOPS_OR_NULL_GOTO(s, out);
382         /* Strip off terminating '\n' */
383         strtok(buf, "\n");
384
385         /* Check if current governor is performance */
386         if (strncmp(buf, POWER_GOVERNOR_PERF,
387                         sizeof(POWER_GOVERNOR_PERF)) == 0) {
388                 ret = 0;
389                 POWER_DEBUG_TRACE("Power management governor of lcore %u is "
390                                 "already performance\n", pi->lcore_id);
391                 goto out;
392         }
393         /* Save the original governor */
394         strlcpy(pi->governor_ori, buf, sizeof(pi->governor_ori));
395
396         /* Write 'performance' to the governor */
397         val = fseek(f, 0, SEEK_SET);
398         FOPS_OR_ERR_GOTO(val, out);
399
400         val = fputs(POWER_GOVERNOR_PERF, f);
401         FOPS_OR_ERR_GOTO(val, out);
402
403         /* We need to flush to see if the fputs succeeds */
404         val = fflush(f);
405         FOPS_OR_ERR_GOTO(val, out);
406
407         ret = 0;
408         RTE_LOG(INFO, POWER, "Power management governor of lcore %u has been "
409                         "set to performance successfully\n", pi->lcore_id);
410 out:
411         fclose(f);
412
413         return ret;
414 }
415
416 /**
417  * It is to check the governor and then set the original governor back if
418  * needed by writing the sys file.
419  */
420 static int
421 power_set_governor_original(struct pstate_power_info *pi)
422 {
423         FILE *f;
424         int ret = -1;
425         char buf[BUFSIZ];
426         char fullpath[PATH_MAX];
427         char *s;
428         int val;
429
430         snprintf(fullpath, sizeof(fullpath), POWER_SYSFILE_GOVERNOR,
431                         pi->lcore_id);
432         f = fopen(fullpath, "rw+");
433         FOPEN_OR_ERR_RET(f, ret);
434
435         s = fgets(buf, sizeof(buf), f);
436         FOPS_OR_NULL_GOTO(s, out);
437
438         /* Check if the governor to be set is the same as current */
439         if (strncmp(buf, pi->governor_ori, sizeof(pi->governor_ori)) == 0) {
440                 ret = 0;
441                 POWER_DEBUG_TRACE("Power management governor of lcore %u "
442                                 "has already been set to %s\n",
443                                 pi->lcore_id, pi->governor_ori);
444                 goto out;
445         }
446
447         /* Write back the original governor */
448         val = fseek(f, 0, SEEK_SET);
449         FOPS_OR_ERR_GOTO(val, out);
450
451         val = fputs(pi->governor_ori, f);
452         FOPS_OR_ERR_GOTO(val, out);
453
454         ret = 0;
455         RTE_LOG(INFO, POWER, "Power management governor of lcore %u "
456                         "has been set back to %s successfully\n",
457                         pi->lcore_id, pi->governor_ori);
458 out:
459         fclose(f);
460
461         return ret;
462 }
463
464 /**
465  * It is to get the available frequencies of the specific lcore by reading the
466  * sys file.
467  */
468 static int
469 power_get_available_freqs(struct pstate_power_info *pi)
470 {
471         FILE *f_min, *f_max;
472         int ret = -1;
473         char *p_min, *p_max;
474         char buf_min[BUFSIZ];
475         char buf_max[BUFSIZ];
476         char fullpath_min[PATH_MAX];
477         char fullpath_max[PATH_MAX];
478         char *s_min, *s_max;
479         uint32_t sys_min_freq = 0, sys_max_freq = 0, base_max_freq = 0;
480         uint32_t i, num_freqs = 0;
481
482         snprintf(fullpath_max, sizeof(fullpath_max),
483                         POWER_SYSFILE_BASE_MAX_FREQ,
484                         pi->lcore_id);
485         snprintf(fullpath_min, sizeof(fullpath_min),
486                         POWER_SYSFILE_BASE_MIN_FREQ,
487                         pi->lcore_id);
488
489         f_min = fopen(fullpath_min, "r");
490         FOPEN_OR_ERR_RET(f_min, ret);
491
492         f_max = fopen(fullpath_max, "r");
493         if (f_max == NULL)
494                 fclose(f_min);
495
496         FOPEN_OR_ERR_RET(f_max, ret);
497
498         s_min = fgets(buf_min, sizeof(buf_min), f_min);
499         FOPS_OR_NULL_GOTO(s_min, out);
500
501         s_max = fgets(buf_max, sizeof(buf_max), f_max);
502         FOPS_OR_NULL_GOTO(s_max, out);
503
504
505         /* Strip the line break if there is */
506         p_min = strchr(buf_min, '\n');
507         if (p_min != NULL)
508                 *p_min = 0;
509
510         p_max = strchr(buf_max, '\n');
511         if (p_max != NULL)
512                 *p_max = 0;
513
514         sys_min_freq = strtoul(buf_min, &p_min, POWER_CONVERT_TO_DECIMAL);
515         sys_max_freq = strtoul(buf_max, &p_max, POWER_CONVERT_TO_DECIMAL);
516
517         if (sys_max_freq < sys_min_freq)
518                 goto out;
519
520         pi->sys_max_freq = sys_max_freq;
521
522         if (pi->priority_core == 1)
523                 base_max_freq = pi->core_base_freq;
524         else
525                 base_max_freq = pi->non_turbo_max_ratio * BUS_FREQ;
526
527         POWER_DEBUG_TRACE("sys min %u, sys max %u, base_max %u\n",
528                         sys_min_freq,
529                         sys_max_freq,
530                         base_max_freq);
531
532         if (base_max_freq < sys_max_freq)
533                 pi->turbo_available = 1;
534         else
535                 pi->turbo_available = 0;
536
537         /* If turbo is available then there is one extra freq bucket
538          * to store the sys max freq which value is base_max +1
539          */
540         num_freqs = (base_max_freq - sys_min_freq) / BUS_FREQ + 1 +
541                 pi->turbo_available;
542
543         /* Generate the freq bucket array.
544          * If turbo is available the freq bucket[0] value is base_max +1
545          * the bucket[1] is base_max, bucket[2] is base_max - BUS_FREQ
546          * and so on.
547          * If turbo is not available bucket[0] is base_max and so on
548          */
549         for (i = 0, pi->nb_freqs = 0; i < num_freqs; i++) {
550                 if ((i == 0) && pi->turbo_available)
551                         pi->freqs[pi->nb_freqs++] = base_max_freq + 1;
552                 else
553                         pi->freqs[pi->nb_freqs++] =
554                         base_max_freq - (i - pi->turbo_available) * BUS_FREQ;
555         }
556
557         ret = 0;
558
559         POWER_DEBUG_TRACE("%d frequency(s) of lcore %u are available\n",
560                         num_freqs, pi->lcore_id);
561
562 out:
563         fclose(f_min);
564         fclose(f_max);
565
566         return ret;
567 }
568
569 static int
570 power_get_cur_idx(struct pstate_power_info *pi)
571 {
572         FILE *f_cur;
573         int ret = -1;
574         char *p_cur;
575         char buf_cur[BUFSIZ];
576         char fullpath_cur[PATH_MAX];
577         char *s_cur;
578         uint32_t sys_cur_freq = 0;
579         unsigned int i;
580
581         snprintf(fullpath_cur, sizeof(fullpath_cur),
582                         POWER_SYSFILE_CUR_FREQ,
583                         pi->lcore_id);
584         f_cur = fopen(fullpath_cur, "r");
585         FOPEN_OR_ERR_RET(f_cur, ret);
586
587         /* initialize the cur_idx to matching current frequency freq index */
588         s_cur = fgets(buf_cur, sizeof(buf_cur), f_cur);
589         FOPS_OR_NULL_GOTO(s_cur, fail);
590
591         p_cur = strchr(buf_cur, '\n');
592         if (p_cur != NULL)
593                 *p_cur = 0;
594         sys_cur_freq = strtoul(buf_cur, &p_cur, POWER_CONVERT_TO_DECIMAL);
595
596         /* convert the frequency to nearest 100000 value
597          * Ex: if sys_cur_freq=1396789 then freq_conv=1400000
598          * Ex: if sys_cur_freq=800030 then freq_conv=800000
599          * Ex: if sys_cur_freq=800030 then freq_conv=800000
600          */
601         unsigned int freq_conv = 0;
602         freq_conv = (sys_cur_freq + FREQ_ROUNDING_DELTA)
603                                 / ROUND_FREQ_TO_N_100000;
604         freq_conv = freq_conv * ROUND_FREQ_TO_N_100000;
605
606         for (i = 0; i < pi->nb_freqs; i++) {
607                 if (freq_conv == pi->freqs[i]) {
608                         pi->curr_idx = i;
609                         break;
610                 }
611         }
612
613         fclose(f_cur);
614         return 0;
615 fail:
616         fclose(f_cur);
617         return ret;
618 }
619
620 int
621 power_pstate_cpufreq_check_supported(void)
622 {
623         return cpufreq_check_scaling_driver(POWER_PSTATE_DRIVER);
624 }
625
626 int
627 power_pstate_cpufreq_init(unsigned int lcore_id)
628 {
629         struct pstate_power_info *pi;
630         uint32_t exp_state;
631
632         if (lcore_id >= RTE_MAX_LCORE) {
633                 RTE_LOG(ERR, POWER, "Lcore id %u can not exceed %u\n",
634                                 lcore_id, RTE_MAX_LCORE - 1U);
635                 return -1;
636         }
637
638         pi = &lcore_power_info[lcore_id];
639         exp_state = POWER_IDLE;
640         /* The power in use state works as a guard variable between
641          * the CPU frequency control initialization and exit process.
642          * The ACQUIRE memory ordering here pairs with the RELEASE
643          * ordering below as lock to make sure the frequency operations
644          * in the critical section are done under the correct state.
645          */
646         if (!__atomic_compare_exchange_n(&(pi->state), &exp_state,
647                                         POWER_ONGOING, 0,
648                                         __ATOMIC_ACQUIRE, __ATOMIC_RELAXED)) {
649                 RTE_LOG(INFO, POWER, "Power management of lcore %u is "
650                                 "in use\n", lcore_id);
651                 return -1;
652         }
653
654         pi->lcore_id = lcore_id;
655         /* Check and set the governor */
656         if (power_set_governor_performance(pi) < 0) {
657                 RTE_LOG(ERR, POWER, "Cannot set governor of lcore %u to "
658                                 "performance\n", lcore_id);
659                 goto fail;
660         }
661         /* Init for setting lcore frequency */
662         if (power_init_for_setting_freq(pi) < 0) {
663                 RTE_LOG(ERR, POWER, "Cannot init for setting frequency for "
664                                 "lcore %u\n", lcore_id);
665                 goto fail;
666         }
667
668         /* Get the available frequencies */
669         if (power_get_available_freqs(pi) < 0) {
670                 RTE_LOG(ERR, POWER, "Cannot get available frequencies of "
671                                 "lcore %u\n", lcore_id);
672                 goto fail;
673         }
674
675         if (power_get_cur_idx(pi) < 0) {
676                 RTE_LOG(ERR, POWER, "Cannot get current frequency "
677                                 "index of lcore %u\n", lcore_id);
678                 goto fail;
679         }
680
681         /* Set freq to max by default */
682         if (power_pstate_cpufreq_freq_max(lcore_id) < 0) {
683                 RTE_LOG(ERR, POWER, "Cannot set frequency of lcore %u "
684                                 "to max\n", lcore_id);
685                 goto fail;
686         }
687
688         RTE_LOG(INFO, POWER, "Initialized successfully for lcore %u "
689                         "power management\n", lcore_id);
690         exp_state = POWER_ONGOING;
691         __atomic_compare_exchange_n(&(pi->state), &exp_state, POWER_USED,
692                                     0, __ATOMIC_RELEASE, __ATOMIC_RELAXED);
693
694         return 0;
695
696 fail:
697         exp_state = POWER_ONGOING;
698         __atomic_compare_exchange_n(&(pi->state), &exp_state, POWER_UNKNOWN,
699                                     0, __ATOMIC_RELEASE, __ATOMIC_RELAXED);
700
701         return -1;
702 }
703
704 int
705 power_pstate_cpufreq_exit(unsigned int lcore_id)
706 {
707         struct pstate_power_info *pi;
708         uint32_t exp_state;
709
710         if (lcore_id >= RTE_MAX_LCORE) {
711                 RTE_LOG(ERR, POWER, "Lcore id %u can not exceeds %u\n",
712                                 lcore_id, RTE_MAX_LCORE - 1U);
713                 return -1;
714         }
715         pi = &lcore_power_info[lcore_id];
716
717         exp_state = POWER_USED;
718         /* The power in use state works as a guard variable between
719          * the CPU frequency control initialization and exit process.
720          * The ACQUIRE memory ordering here pairs with the RELEASE
721          * ordering below as lock to make sure the frequency operations
722          * in the critical section are under done the correct state.
723          */
724         if (!__atomic_compare_exchange_n(&(pi->state), &exp_state,
725                                         POWER_ONGOING, 0,
726                                         __ATOMIC_ACQUIRE, __ATOMIC_RELAXED)) {
727                 RTE_LOG(INFO, POWER, "Power management of lcore %u is "
728                                 "not used\n", lcore_id);
729                 return -1;
730         }
731
732         /* Close FD of setting freq */
733         fclose(pi->f_cur_min);
734         fclose(pi->f_cur_max);
735         pi->f_cur_min = NULL;
736         pi->f_cur_max = NULL;
737
738         /* Set the governor back to the original */
739         if (power_set_governor_original(pi) < 0) {
740                 RTE_LOG(ERR, POWER, "Cannot set the governor of %u back "
741                                 "to the original\n", lcore_id);
742                 goto fail;
743         }
744
745         RTE_LOG(INFO, POWER, "Power management of lcore %u has exited from "
746                         "'performance' mode and been set back to the "
747                         "original\n", lcore_id);
748         exp_state = POWER_ONGOING;
749         __atomic_compare_exchange_n(&(pi->state), &exp_state, POWER_IDLE,
750                                     0, __ATOMIC_RELEASE, __ATOMIC_RELAXED);
751
752         return 0;
753
754 fail:
755         exp_state = POWER_ONGOING;
756         __atomic_compare_exchange_n(&(pi->state), &exp_state, POWER_UNKNOWN,
757                                     0, __ATOMIC_RELEASE, __ATOMIC_RELAXED);
758
759         return -1;
760 }
761
762
763 uint32_t
764 power_pstate_cpufreq_freqs(unsigned int lcore_id, uint32_t *freqs, uint32_t num)
765 {
766         struct pstate_power_info *pi;
767
768         if (lcore_id >= RTE_MAX_LCORE) {
769                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
770                 return 0;
771         }
772
773         if (freqs == NULL) {
774                 RTE_LOG(ERR, POWER, "NULL buffer supplied\n");
775                 return 0;
776         }
777
778         pi = &lcore_power_info[lcore_id];
779         if (num < pi->nb_freqs) {
780                 RTE_LOG(ERR, POWER, "Buffer size is not enough\n");
781                 return 0;
782         }
783         rte_memcpy(freqs, pi->freqs, pi->nb_freqs * sizeof(uint32_t));
784
785         return pi->nb_freqs;
786 }
787
788 uint32_t
789 power_pstate_cpufreq_get_freq(unsigned int lcore_id)
790 {
791         if (lcore_id >= RTE_MAX_LCORE) {
792                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
793                 return RTE_POWER_INVALID_FREQ_INDEX;
794         }
795
796         return lcore_power_info[lcore_id].curr_idx;
797 }
798
799
800 int
801 power_pstate_cpufreq_set_freq(unsigned int lcore_id, uint32_t index)
802 {
803         if (lcore_id >= RTE_MAX_LCORE) {
804                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
805                 return -1;
806         }
807
808         return set_freq_internal(&(lcore_power_info[lcore_id]), index);
809 }
810
811 int
812 power_pstate_cpufreq_freq_up(unsigned int lcore_id)
813 {
814         struct pstate_power_info *pi;
815
816         if (lcore_id >= RTE_MAX_LCORE) {
817                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
818                 return -1;
819         }
820
821         pi = &lcore_power_info[lcore_id];
822         if (pi->curr_idx == 0 ||
823             (pi->curr_idx == 1 && pi->turbo_available && !pi->turbo_enable))
824                 return 0;
825
826         /* Frequencies in the array are from high to low. */
827         return set_freq_internal(pi, pi->curr_idx - 1);
828 }
829
830 int
831 power_pstate_cpufreq_freq_down(unsigned int lcore_id)
832 {
833         struct pstate_power_info *pi;
834
835         if (lcore_id >= RTE_MAX_LCORE) {
836                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
837                 return -1;
838         }
839
840         pi = &lcore_power_info[lcore_id];
841         if (pi->curr_idx + 1 == pi->nb_freqs)
842                 return 0;
843
844         /* Frequencies in the array are from high to low. */
845         return set_freq_internal(pi, pi->curr_idx + 1);
846 }
847
848 int
849 power_pstate_cpufreq_freq_max(unsigned int lcore_id)
850 {
851         if (lcore_id >= RTE_MAX_LCORE) {
852                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
853                 return -1;
854         }
855
856         /* Frequencies in the array are from high to low. */
857         if (lcore_power_info[lcore_id].turbo_available) {
858                 if (lcore_power_info[lcore_id].turbo_enable)
859                         /* Set to Turbo */
860                         return set_freq_internal(
861                                         &lcore_power_info[lcore_id], 0);
862                 else
863                         /* Set to max non-turbo */
864                         return set_freq_internal(
865                                         &lcore_power_info[lcore_id], 1);
866         } else
867                 return set_freq_internal(&lcore_power_info[lcore_id], 0);
868 }
869
870
871 int
872 power_pstate_cpufreq_freq_min(unsigned int lcore_id)
873 {
874         struct pstate_power_info *pi;
875
876         if (lcore_id >= RTE_MAX_LCORE) {
877                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
878                 return -1;
879         }
880
881         pi = &lcore_power_info[lcore_id];
882
883         /* Frequencies in the array are from high to low. */
884         return set_freq_internal(pi, pi->nb_freqs - 1);
885 }
886
887
888 int
889 power_pstate_turbo_status(unsigned int lcore_id)
890 {
891         struct pstate_power_info *pi;
892
893         if (lcore_id >= RTE_MAX_LCORE) {
894                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
895                 return -1;
896         }
897
898         pi = &lcore_power_info[lcore_id];
899
900         return pi->turbo_enable;
901 }
902
903 int
904 power_pstate_enable_turbo(unsigned int lcore_id)
905 {
906         struct pstate_power_info *pi;
907
908         if (lcore_id >= RTE_MAX_LCORE) {
909                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
910                 return -1;
911         }
912
913         pi = &lcore_power_info[lcore_id];
914
915         if (pi->turbo_available)
916                 pi->turbo_enable = 1;
917         else {
918                 pi->turbo_enable = 0;
919                 RTE_LOG(ERR, POWER,
920                         "Failed to enable turbo on lcore %u\n",
921                         lcore_id);
922                         return -1;
923         }
924
925         return 0;
926 }
927
928
929 int
930 power_pstate_disable_turbo(unsigned int lcore_id)
931 {
932         struct pstate_power_info *pi;
933
934         if (lcore_id >= RTE_MAX_LCORE) {
935                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
936                 return -1;
937         }
938
939         pi = &lcore_power_info[lcore_id];
940
941         pi->turbo_enable = 0;
942
943         if (pi->turbo_available && pi->curr_idx <= 1) {
944                 /* Try to set freq to max by default coming out of turbo */
945                 if (power_pstate_cpufreq_freq_max(lcore_id) < 0) {
946                         RTE_LOG(ERR, POWER,
947                                 "Failed to set frequency of lcore %u to max\n",
948                                 lcore_id);
949                         return -1;
950                 }
951         }
952
953         return 0;
954 }
955
956
957 int power_pstate_get_capabilities(unsigned int lcore_id,
958                 struct rte_power_core_capabilities *caps)
959 {
960         struct pstate_power_info *pi;
961
962         if (lcore_id >= RTE_MAX_LCORE) {
963                 RTE_LOG(ERR, POWER, "Invalid lcore ID\n");
964                 return -1;
965         }
966         if (caps == NULL) {
967                 RTE_LOG(ERR, POWER, "Invalid argument\n");
968                 return -1;
969         }
970
971         pi = &lcore_power_info[lcore_id];
972         caps->capabilities = 0;
973         caps->turbo = !!(pi->turbo_available);
974         caps->priority = pi->priority_core;
975
976         return 0;
977 }