Unify comment style

Author: qzed

examples/dtx.c

@@ -26,14 +26,14 @@ int main()
 		return -1;
 	}
 
-	// enable events
+	/* Enable events. */
 	status = ioctl(fd, SDTX_IOCTL_EVENTS_ENABLE);
 	if (status < 0) {
 		printf("error: Failed to enable events: %s\n", strerror(errno));
 		return -1;
 	}
 
-	// read events
+	/* Read events. */
 	while (true) {
 		struct sdtx_event *event = (struct sdtx_event *)&buffer[0];
 		ssize_t n;
@@ -52,7 +52,7 @@ int main()
 			       event->code, event->length);
 
 			if (event->code == SDTX_EVENT_REQUEST) {
-				// send confirmation command
+				/* Send confirmation command. */
 				status = ioctl(fd, SDTX_IOCTL_LATCH_CONFIRM);
 				if (status < 0) {
 					printf("error: Failed to send command: %s\n",

module/include/linux/surface_aggregator/serial_hub.h

@@ -292,15 +292,15 @@ struct ssam_span {
  * Windows driver.
  */
 enum ssam_ssh_tc {
-				// category 0x00 is invalid for EC use
-	SSAM_SSH_TC_SAM = 0x01,	// generic system functionality, real-time clock
-	SSAM_SSH_TC_BAT = 0x02,	// battery/power subsystem
-	SSAM_SSH_TC_TMP = 0x03,	// thermal subsystem
+				/* Category 0x00 is invalid for EC use. */
+	SSAM_SSH_TC_SAM = 0x01,	/* Generic system functionality, real-time clock. */
+	SSAM_SSH_TC_BAT = 0x02,	/* Battery/power subsystem. */
+	SSAM_SSH_TC_TMP = 0x03,	/* Thermal subsystem. */
 	SSAM_SSH_TC_PMC = 0x04,
 	SSAM_SSH_TC_FAN = 0x05,
 	SSAM_SSH_TC_PoM = 0x06,
 	SSAM_SSH_TC_DBG = 0x07,
-	SSAM_SSH_TC_KBD = 0x08,	// legacy keyboard (Laptop 1/2)
+	SSAM_SSH_TC_KBD = 0x08,	/* Legacy keyboard (Laptop 1/2). */
 	SSAM_SSH_TC_FWU = 0x09,
 	SSAM_SSH_TC_UNI = 0x0a,
 	SSAM_SSH_TC_LPC = 0x0b,
@@ -309,11 +309,11 @@ enum ssam_ssh_tc {
 	SSAM_SSH_TC_KIP = 0x0e,
 	SSAM_SSH_TC_EXT = 0x0f,
 	SSAM_SSH_TC_BLD = 0x10,
-	SSAM_SSH_TC_BAS = 0x11,	// detachment system (Surface Book 2/3)
+	SSAM_SSH_TC_BAS = 0x11,	/* Detachment system (Surface Book 2/3). */
 	SSAM_SSH_TC_SEN = 0x12,
 	SSAM_SSH_TC_SRQ = 0x13,
 	SSAM_SSH_TC_MCU = 0x14,
-	SSAM_SSH_TC_HID = 0x15,	// generic HID input subsystem
+	SSAM_SSH_TC_HID = 0x15,	/* Generic HID input subsystem. */
 	SSAM_SSH_TC_TCH = 0x16,
 	SSAM_SSH_TC_BKL = 0x17,
 	SSAM_SSH_TC_TAM = 0x18,
@@ -325,7 +325,7 @@ enum ssam_ssh_tc {
 	SSAM_SSH_TC_AUD = 0x1e,
 	SSAM_SSH_TC_SMC = 0x1f,
 	SSAM_SSH_TC_KPD = 0x20,
-	SSAM_SSH_TC_REG = 0x21,	// extended event registry
+	SSAM_SSH_TC_REG = 0x21,	/* Extended event registry. */
 };
 
 

module/src/clients/surface_acpi_notify.c

@@ -177,7 +177,7 @@ enum sam_event_cid_tmp {
 struct san_event_work {
 	struct delayed_work work;
 	struct device *dev;
-	struct ssam_event event;	// must be last
+	struct ssam_event event;	/* must be last */
 };
 
 static int san_acpi_notify_event(struct device *dev, u64 func,
@@ -410,39 +410,39 @@ struct gsb_data_in {
 } __packed;
 
 struct gsb_data_rqsx {
-	u8 cv;				// command value (san_gsb_request_cv)
-	u8 tc;				// target category
-	u8 tid;				// target ID
-	u8 iid;				// instance ID
-	u8 snc;				// expect-response-flag?
-	u8 cid;				// command ID
-	u16 cdl;			// payload length
-	u8 pld[];			// payload
+	u8 cv;				/* Command value (san_gsb_request_cv). */
+	u8 tc;				/* Target category. */
+	u8 tid;				/* Target ID. */
+	u8 iid;				/* Instance ID. */
+	u8 snc;				/* Expect-response-flag. */
+	u8 cid;				/* Command ID. */
+	u16 cdl;			/* Payload length. */
+	u8 pld[];			/* Payload. */
 } __packed;
 
 struct gsb_data_etwl {
-	u8 cv;				// command value (should be 0x02)
-	u8 etw3;			// unknown
-	u8 etw4;			// unknown
-	u8 msg[];			// error message (ASCIIZ)
+	u8 cv;				/* Command value (should be 0x02). */
+	u8 etw3;			/* Unknown. */
+	u8 etw4;			/* Unknown. */
+	u8 msg[];			/* Error message (ASCIIZ). */
 } __packed;
 
 struct gsb_data_out {
-	u8 status;			// _SSH communication status
-	u8 len;				// _SSH payload length
-	u8 pld[];			// _SSH payload
+	u8 status;			/* _SSH communication status. */
+	u8 len;				/* _SSH payload length. */
+	u8 pld[];			/* _SSH payload. */
 } __packed;
 
 union gsb_buffer_data {
-	struct gsb_data_in   in;	// common input
-	struct gsb_data_rqsx rqsx;	// RQSX input
-	struct gsb_data_etwl etwl;	// ETWL input
-	struct gsb_data_out  out;	// output
+	struct gsb_data_in   in;	/* Common input. */
+	struct gsb_data_rqsx rqsx;	/* RQSX input. */
+	struct gsb_data_etwl etwl;	/* ETWL input. */
+	struct gsb_data_out  out;	/* Output. */
 };
 
 struct gsb_buffer {
-	u8 status;			// GSB AttribRawProcess status
-	u8 len;				// GSB AttribRawProcess length
+	u8 status;			/* GSB AttribRawProcess status. */
+	u8 len;				/* GSB AttribRawProcess length. */
 	union gsb_buffer_data data;
 } __packed;
 
@@ -472,7 +472,7 @@ static acpi_status san_etwl(struct san_data *d, struct gsb_buffer *b)
 		(unsigned int)(b->len - sizeof(struct gsb_data_etwl)),
 		(char *)etwl->msg);
 
-	// indicate success
+	/* Indicate success. */
 	b->status = 0x00;
 	b->len = 0x00;
 
@@ -579,7 +579,7 @@ static acpi_status san_rqst(struct san_data *d, struct gsb_buffer *buffer)
 	rsp.length = 0;
 	rsp.pointer = &rspbuf[0];
 
-	// handle suspended device
+	/* Handle suspended device. */
 	if (d->dev->power.is_suspended) {
 		dev_warn(d->dev, "rqst: device is suspended, not executing\n");
 		return san_rqst_fixup_suspended(d, &rqst, buffer);
@@ -644,7 +644,7 @@ static acpi_status san_opreg_handler(u32 function,
 		return AE_OK;
 	}
 
-	// buffer must have at least contain the command-value
+	/* Buffer must have at least contain the command-value. */
 	if (buffer->len == 0) {
 		dev_err(d->dev, "request-package too small\n");
 		return AE_OK;
@@ -766,13 +766,13 @@ static acpi_status san_consumer_setup(acpi_handle handle, u32 lvl,
 	if (!is_san_consumer(pdev, handle))
 		return AE_OK;
 
-	// ignore ACPI devices that are not present
+	/* Ignore ACPI devices that are not present. */
 	if (acpi_bus_get_device(handle, &adev) != 0)
 		return AE_OK;
 
 	san_consumer_dbg(&pdev->dev, handle, "creating device link\n");
 
-	// try to set up device links, ignore but log errors
+	/* Try to set up device links, ignore but log errors. */
 	link = device_link_add(&adev->dev, &pdev->dev, flags);
 	if (!link) {
 		san_consumer_warn(&pdev->dev, handle,

module/src/clients/surface_aggregator_cdev.c

@@ -80,7 +80,7 @@ static long ssam_cdev_request(struct ssam_cdev *cdev, unsigned long arg)
 	plddata = u64_to_user_ptr(rqst.payload.data);
 	rspdata = u64_to_user_ptr(rqst.response.data);
 
-	// setup basic request fields
+	/* Setup basic request fields. */
 	spec.target_category = rqst.target_category;
 	spec.target_id = rqst.target_id;
 	spec.command_id = rqst.command_id;
@@ -93,7 +93,7 @@ static long ssam_cdev_request(struct ssam_cdev *cdev, unsigned long arg)
 	rsp.length = 0;
 	rsp.pointer = NULL;
 
-	// get request payload from user-space
+	/* Get request payload from user-space. */
 	if (spec.length) {
 		if (!plddata) {
 			ret = -EINVAL;
@@ -113,7 +113,7 @@ static long ssam_cdev_request(struct ssam_cdev *cdev, unsigned long arg)
 		}
 	}
 
-	// allocate response buffer
+	/* Allocate response buffer. */
 	if (rsp.capacity) {
 		if (!rspdata) {
 			ret = -EINVAL;
@@ -128,17 +128,17 @@ static long ssam_cdev_request(struct ssam_cdev *cdev, unsigned long arg)
 		}
 	}
 
-	// perform request
+	/* Perform request. */
 	status = ssam_request_sync(cdev->ctrl, &spec, &rsp);
 	if (status)
 		goto out;
 
-	// copy response to user-space
+	/* Copy response to user-space. */
 	if (rsp.length && copy_to_user(rspdata, rsp.pointer, rsp.length))
 		ret = -EFAULT;
 
 out:
-	// always try to set response-length and status
+	/* Always try to set response-length and status. */
 	tmp = put_user(rsp.length, &r->response.length);
 	if (tmp)
 		ret = tmp;
@@ -147,7 +147,7 @@ static long ssam_cdev_request(struct ssam_cdev *cdev, unsigned long arg)
 	if (tmp)
 		ret = tmp;
 
-	// cleanup
+	/* Cleanup. */
 	kfree(spec.payload);
 	kfree(rsp.pointer);
 
@@ -172,7 +172,7 @@ static long ssam_cdev_device_ioctl(struct file *file, unsigned int cmd,
 	struct ssam_cdev *cdev = file->private_data;
 	long status;
 
-	// ensure that controller is valid for as long as we need it
+	/* Ensure that controller is valid for as long as we need it. */
 	if (down_read_killable(&cdev->lock))
 		return -ERESTARTSYS;
 

module/src/clients/surface_aggregator_registry.c

@@ -450,7 +450,7 @@ static int ssam_base_hub_probe(struct ssam_device *sdev)
 	hub->sdev = sdev;
 	hub->state = SSAM_BASE_HUB_UNINITIALIZED;
 
-	hub->notif.base.priority = 1000;  // this notifier should run first
+	hub->notif.base.priority = 1000;  /* This notifier should run first. */
 	hub->notif.base.fn = ssam_base_hub_notif;
 	hub->notif.event.reg = SSAM_EVENT_REGISTRY_SAM;
 	hub->notif.event.id.target_category = SSAM_SSH_TC_BAS,

module/src/clients/surface_battery.c

@@ -119,7 +119,7 @@ static SSAM_DEFINE_SYNC_REQUEST_CL_W(ssam_bat_set_btp, __le32, {
 	.command_id      = 0x04,
 });
 
-/* Get platform power soruce for battery (DPTF PSRC) */
+/* Get platform power source for battery (DPTF PSRC). */
 static SSAM_DEFINE_SYNC_REQUEST_CL_R(ssam_bat_get_psrc, __le32, {
 	.target_category = SSAM_SSH_TC_BAT,
 	.command_id      = 0x0d,
@@ -259,7 +259,7 @@ static int spwr_battery_load_bix(struct spwr_battery_device *bat)
 
 	status = ssam_retry(ssam_bat_get_bix, bat->sdev, &bat->bix);
 
-	// enforce NULL terminated strings in case anything goes wrong...
+	/* Enforce NULL terminated strings in case anything goes wrong... */
 	bat->bix.model[ARRAY_SIZE(bat->bix.model) - 1] = 0;
 	bat->bix.serial[ARRAY_SIZE(bat->bix.serial) - 1] = 0;
 	bat->bix.type[ARRAY_SIZE(bat->bix.type) - 1] = 0;
@@ -413,7 +413,7 @@ static int spwr_battery_recheck_full(struct spwr_battery_device *bat)
 	if (status)
 		goto out;
 
-	// if battery has been attached, (re-)initialize alarm
+	/* If battery has been attached, (re-)initialize alarm. */
 	if (!present && spwr_battery_present(bat)) {
 		u32 cap_warn = get_unaligned_le32(&bat->bix.design_cap_warn);
 
@@ -496,7 +496,7 @@ static u32 spwr_notify_bat(struct ssam_event_notifier *nf,
 	dev_dbg(&bat->sdev->dev, "power event (cid = 0x%02x, iid = %d, tid = %d)\n",
 		event->command_id, event->instance_id, event->target_id);
 
-	// handled here, needs to be handled for all targets/instances
+	/* Handled here, needs to be handled for all targets/instances. */
 	if (event->command_id == SAM_EVENT_CID_BAT_ADP) {
 		status = spwr_battery_recheck_adapter(bat);
 		return ssam_notifier_from_errno(status) | SSAM_NOTIF_HANDLED;
@@ -700,7 +700,7 @@ static int spwr_battery_get_property(struct power_supply *psy,
 	if (status)
 		goto out;
 
-	// abort if battery is not present
+	/* Abort if battery is not present. */
 	if (!spwr_battery_present(bat) && psp != POWER_SUPPLY_PROP_PRESENT) {
 		status = -ENODEV;
 		goto out;
@@ -884,7 +884,7 @@ static int spwr_ac_register(struct spwr_ac_device *ac)
 	__le32 sta;
 	int status;
 
-	// make sure the device is there and functioning properly
+	/* Make sure the device is there and functioning properly. */
 	status = ssam_retry(ssam_bat_get_sta, ac->sdev, &sta);
 	if (status)
 		return status;
@@ -947,7 +947,7 @@ static int spwr_battery_register(struct spwr_battery_device *bat)
 	__le32 sta;
 	int status;
 
-	// make sure the device is there and functioning properly
+	/* Make sure the device is there and functioning properly. */
 	status = ssam_retry(ssam_bat_get_sta, bat->sdev, &sta);
 	if (status)
 		return status;