]> sigrok.org Git - libsigrok.git/blobdiff - output/common.c
remove dead code
[libsigrok.git] / output / common.c
index 1fc5df7d3517f3ce18d0b844c775bf438c6069cb..77914956607b54fa25a98c7ed7f98a85d454e786 100644 (file)
  * @return A malloc()ed string representation of the samplerate value,
  *         or NULL upon errors. The caller is responsible to free() the memory.
  */
-char *sigrok_samplerate_string(uint64_t samplerate)
+char *sr_samplerate_string(uint64_t samplerate)
 {
        char *o;
        int r;
 
        o = malloc(30 + 1); /* Enough for a uint64_t as string + " GHz". */
-       if (o == NULL)
+       if (!o)
                return NULL;
 
        if (samplerate >= GHZ(1))
@@ -58,3 +58,40 @@ char *sigrok_samplerate_string(uint64_t samplerate)
 
        return o;
 }
+
+/**
+ * Convert a numeric samplerate value to the "natural" string representation
+ * of its period.
+ *
+ * E.g. a value of 3000000 would be converted to "3 us", 20000 to "50 ms".
+ *
+ * @param frequency The frequency in Hz.
+ * @return A malloc()ed string representation of the frequency value,
+ *         or NULL upon errors. The caller is responsible to free() the memory.
+ */
+char *sr_period_string(uint64_t frequency)
+{
+       char *o;
+       int r;
+
+       o = malloc(30 + 1); /* Enough for a uint64_t as string + " ms". */
+       if (!o)
+               return NULL;
+
+       if (frequency >= GHZ(1))
+               r = snprintf(o, 30, "%" PRIu64 " ns", frequency / 1000000000);
+       else if (frequency >= MHZ(1))
+               r = snprintf(o, 30, "%" PRIu64 " us", frequency / 1000000);
+       else if (frequency >= KHZ(1))
+               r = snprintf(o, 30, "%" PRIu64 " ms", frequency / 1000);
+       else
+               r = snprintf(o, 30, "%" PRIu64 " s", frequency);
+
+       if (r < 0) {
+               /* Something went wrong... */
+               free(o);
+               return NULL;
+       }
+
+       return o;
+}