media: cec: rename pin events/function
authorHans Verkuil <hverkuil@xs4all.nl>
Tue, 15 Aug 2017 19:26:25 +0000 (15:26 -0400)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Sun, 20 Aug 2017 12:14:03 +0000 (08:14 -0400)
The CEC_EVENT_PIN_LOW/HIGH defines and the cec_queue_pin_event() function
did not specify that these were about CEC pin events.

Since in the future there will also be HPD pin events it is wise to rename
the event defines and function to CEC_EVENT_PIN_CEC_LOW/HIGH and
cec_queue_pin_cec_event() now before these become part of the ABI.

Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Documentation/media/uapi/cec/cec-ioc-adap-g-caps.rst
Documentation/media/uapi/cec/cec-ioc-dqevent.rst
Documentation/media/uapi/cec/cec-ioc-g-mode.rst
drivers/media/cec/cec-adap.c
drivers/media/cec/cec-api.c
drivers/media/cec/cec-pin.c
include/media/cec.h
include/uapi/linux/cec.h

index 0a7aa21f24f479c2263b86448af27fb18f8c6ce8..6c1f6efb822e3012527c9d18e53b0a39936351bd 100644 (file)
@@ -127,7 +127,7 @@ returns the information to the application. The ioctl never fails.
       - 0x00000080
       - The CEC hardware can monitor CEC pin changes from low to high voltage
         and vice versa. When in pin monitoring mode the application will
-       receive ``CEC_EVENT_PIN_LOW`` and ``CEC_EVENT_PIN_HIGH`` events.
+       receive ``CEC_EVENT_PIN_CEC_LOW`` and ``CEC_EVENT_PIN_CEC_HIGH`` events.
 
 
 
index 766d8b0ce43166f298eeab2c90d038d39eb66dda..db615e3405c040d6dfd5b5dad51d8489d4033617 100644 (file)
@@ -146,16 +146,16 @@ it is guaranteed that the state did change in between the two events.
       - 2
       - Generated if one or more CEC messages were lost because the
        application didn't dequeue CEC messages fast enough.
-    * .. _`CEC-EVENT-PIN-LOW`:
+    * .. _`CEC-EVENT-PIN-CEC-LOW`:
 
-      - ``CEC_EVENT_PIN_LOW``
+      - ``CEC_EVENT_PIN_CEC_LOW``
       - 3
       - Generated if the CEC pin goes from a high voltage to a low voltage.
         Only applies to adapters that have the ``CEC_CAP_MONITOR_PIN``
        capability set.
-    * .. _`CEC-EVENT-PIN-HIGH`:
+    * .. _`CEC-EVENT-PIN-CEC-HIGH`:
 
-      - ``CEC_EVENT_PIN_HIGH``
+      - ``CEC_EVENT_PIN_CEC_HIGH``
       - 4
       - Generated if the CEC pin goes from a low voltage to a high voltage.
         Only applies to adapters that have the ``CEC_CAP_MONITOR_PIN``
index 494154e9d4492401af39d80f8ad3f62df9a24c54..4d8e0647e832a4aeee586b2c564a677ff1b3a57b 100644 (file)
@@ -159,7 +159,7 @@ Available follower modes are:
        This mode requires that the :ref:`CEC_CAP_MONITOR_PIN <CEC-CAP-MONITOR-PIN>`
        capability is set, otherwise the ``EINVAL`` error code is returned.
        While in pin monitoring mode this file descriptor can receive the
-       ``CEC_EVENT_PIN_LOW`` and ``CEC_EVENT_PIN_HIGH`` events to see the
+       ``CEC_EVENT_PIN_CEC_LOW`` and ``CEC_EVENT_PIN_CEC_HIGH`` events to see the
        low-level CEC pin transitions. This is very useful for debugging.
        This mode is only allowed if the process has the ``CAP_NET_ADMIN``
        capability. If that is not set, then the ``EPERM`` error code is returned.
index 8ac39ddf892c6bd39d50cde7b8481d3a1e025a8d..d9adeb505c097f18ebec12ea84d09b407a22ee04 100644 (file)
@@ -154,10 +154,11 @@ static void cec_queue_event(struct cec_adapter *adap,
 }
 
 /* Notify userspace that the CEC pin changed state at the given time. */
-void cec_queue_pin_event(struct cec_adapter *adap, bool is_high, ktime_t ts)
+void cec_queue_pin_cec_event(struct cec_adapter *adap, bool is_high, ktime_t ts)
 {
        struct cec_event ev = {
-               .event = is_high ? CEC_EVENT_PIN_HIGH : CEC_EVENT_PIN_LOW,
+               .event = is_high ? CEC_EVENT_PIN_CEC_HIGH :
+                                  CEC_EVENT_PIN_CEC_LOW,
        };
        struct cec_fh *fh;
 
@@ -167,7 +168,7 @@ void cec_queue_pin_event(struct cec_adapter *adap, bool is_high, ktime_t ts)
                        cec_queue_event_fh(fh, &ev, ktime_to_ns(ts));
        mutex_unlock(&adap->devnode.lock);
 }
-EXPORT_SYMBOL_GPL(cec_queue_pin_event);
+EXPORT_SYMBOL_GPL(cec_queue_pin_cec_event);
 
 /*
  * Queue a new message for this filehandle.
index 00d43d74020f9cae79fe5a375069f859ea2a588d..87649b0c6381141013f8dedbf5da2035b4f14752 100644 (file)
@@ -449,8 +449,8 @@ static long cec_s_mode(struct cec_adapter *adap, struct cec_fh *fh,
                        .flags = CEC_EVENT_FL_INITIAL_STATE,
                };
 
-               ev.event = adap->pin->cur_value ? CEC_EVENT_PIN_HIGH :
-                                                 CEC_EVENT_PIN_LOW;
+               ev.event = adap->pin->cur_value ? CEC_EVENT_PIN_CEC_HIGH :
+                                                 CEC_EVENT_PIN_CEC_LOW;
                cec_queue_event_fh(fh, &ev, 0);
 #endif
                adap->monitor_pin_cnt++;
index 03f800e5ec1f08a661feb7bb784fdbc6e3244147..31a26d3b8bd88bb71a9958bb509f12e729519763 100644 (file)
@@ -609,8 +609,9 @@ static int cec_pin_thread_func(void *_adap)
                while (atomic_read(&pin->work_pin_events)) {
                        unsigned int idx = pin->work_pin_events_rd;
 
-                       cec_queue_pin_event(adap, pin->work_pin_is_high[idx],
-                                           pin->work_pin_ts[idx]);
+                       cec_queue_pin_cec_event(adap,
+                                               pin->work_pin_is_high[idx],
+                                               pin->work_pin_ts[idx]);
                        pin->work_pin_events_rd = (idx + 1) % CEC_NUM_PIN_EVENTS;
                        atomic_dec(&pin->work_pin_events);
                }
index 1bec7bde4792f013c308851e099c09fc8350a625..224359c9941a9a805a172891b00a87e5b4fa62af 100644 (file)
@@ -91,7 +91,7 @@ struct cec_event_entry {
 };
 
 #define CEC_NUM_CORE_EVENTS 2
-#define CEC_NUM_EVENTS CEC_EVENT_PIN_HIGH
+#define CEC_NUM_EVENTS CEC_EVENT_PIN_CEC_HIGH
 
 struct cec_fh {
        struct list_head        list;
@@ -280,14 +280,15 @@ static inline void cec_received_msg(struct cec_adapter *adap,
 }
 
 /**
- * cec_queue_pin_event() - queue a pin event with a given timestamp.
+ * cec_queue_pin_cec_event() - queue a CEC pin event with a given timestamp.
  *
  * @adap:      pointer to the cec adapter
- * @is_high:   when true the pin is high, otherwise it is low
+ * @is_high:   when true the CEC pin is high, otherwise it is low
  * @ts:                the timestamp for this event
  *
  */
-void cec_queue_pin_event(struct cec_adapter *adap, bool is_high, ktime_t ts);
+void cec_queue_pin_cec_event(struct cec_adapter *adap,
+                            bool is_high, ktime_t ts);
 
 /**
  * cec_get_edid_phys_addr() - find and return the physical address
index d87a67b0bb0656344b958365f74da5f56871efb3..4351c3481aea19720c2c96130f3a642bb5bfb44d 100644 (file)
@@ -408,8 +408,8 @@ struct cec_log_addrs {
  * didn't empty the message queue in time
  */
 #define CEC_EVENT_LOST_MSGS            2
-#define CEC_EVENT_PIN_LOW              3
-#define CEC_EVENT_PIN_HIGH             4
+#define CEC_EVENT_PIN_CEC_LOW          3
+#define CEC_EVENT_PIN_CEC_HIGH         4
 
 #define CEC_EVENT_FL_INITIAL_STATE     (1 << 0)
 #define CEC_EVENT_FL_DROPPED_EVENTS    (1 << 1)