841 lines · 23.2 KB · C
RawDownload
// SPDX-License-Identifier: GPL-2.0/* * Apple Touch Bar DRM Driver * * Copyright (c) 2023 Kerem Karabay <kekrby@gmail.com> */ #include <linux/align.h>#include <linux/array_size.h>#include <linux/bitops.h>#include <linux/bug.h>#include <linux/container_of.h>#include <linux/err.h>#include <linux/module.h>#include <linux/overflow.h>#include <linux/slab.h>#include <linux/types.h>#include <linux/unaligned.h>#include <linux/usb.h> #include <drm/drm_atomic.h>#include <drm/drm_atomic_helper.h>#include <drm/drm_crtc.h>#include <drm/drm_damage_helper.h>#include <drm/drm_drv.h>#include <drm/drm_encoder.h>#include <drm/drm_format_helper.h>#include <drm/drm_fourcc.h>#include <drm/drm_framebuffer.h>#include <drm/drm_gem_atomic_helper.h>#include <drm/drm_gem_framebuffer_helper.h>#include <drm/drm_gem_shmem_helper.h>#include <drm/drm_plane.h>#include <drm/drm_print.h>#include <drm/drm_probe_helper.h> #define APPLETBDRM_PIXEL_FORMAT		cpu_to_le32(0x52474241) /* RGBA, the actual format is BGR888 */#define APPLETBDRM_BITS_PER_PIXEL	24 #define APPLETBDRM_MSG_CLEAR_DISPLAY	cpu_to_le32(0x434c5244) /* CLRD */#define APPLETBDRM_MSG_GET_INFORMATION	cpu_to_le32(0x47494e46) /* GINF */#define APPLETBDRM_MSG_UPDATE_COMPLETE	cpu_to_le32(0x5544434c) /* UDCL */#define APPLETBDRM_MSG_SIGNAL_READINESS	cpu_to_le32(0x52454459) /* REDY */ #define APPLETBDRM_BULK_MSG_TIMEOUT	1000 #define drm_to_adev(_drm)		container_of(_drm, struct appletbdrm_device, drm)#define adev_to_udev(adev)		interface_to_usbdev(to_usb_interface((adev)->drm.dev)) struct appletbdrm_msg_request_header {	__le16 unk_00;	__le16 unk_02;	__le32 unk_04;	__le32 unk_08;	__le32 size;} __packed; struct appletbdrm_msg_response_header {	u8 unk_00[16];	__le32 msg;} __packed; struct appletbdrm_msg_simple_request {	struct appletbdrm_msg_request_header header;	__le32 msg;	u8 unk_14[8];	__le32 size;} __packed; struct appletbdrm_msg_information {	struct appletbdrm_msg_response_header header;	u8 unk_14[12];	__le32 width;	__le32 height;	u8 bits_per_pixel;	__le32 bytes_per_row;	__le32 orientation;	__le32 bitmap_info;	__le32 pixel_format;	__le32 width_inches;	/* floating point */	__le32 height_inches;	/* floating point */} __packed; struct appletbdrm_frame {	__le16 begin_x;	__le16 begin_y;	__le16 width;	__le16 height;	__le32 buf_size;	u8 buf[];} __packed; struct appletbdrm_fb_request_footer {	u8 unk_00[12];	__le32 unk_0c;	u8 unk_10[12];	__le32 unk_1c;	__le64 timestamp;	u8 unk_28[12];	__le32 unk_34;	u8 unk_38[20];	__le32 unk_4c;} __packed; struct appletbdrm_fb_request {	struct appletbdrm_msg_request_header header;	__le16 unk_10;	u8 msg_id;	u8 unk_13[29];	/*	 * Contents of `data`:	 * - struct appletbdrm_frame frames[];	 * - struct appletbdrm_fb_request_footer footer;	 * - padding to make the total size a multiple of 16	 */	u8 data[];} __packed; struct appletbdrm_fb_request_response {	struct appletbdrm_msg_response_header header;	u8 unk_14[12];	__le64 timestamp;} __packed; struct appletbdrm_device {	unsigned int in_ep;	unsigned int out_ep; 	unsigned int width;	unsigned int height; 	struct drm_device drm;	struct drm_display_mode mode;	struct drm_connector connector;	struct drm_plane primary_plane;	struct drm_crtc crtc;	struct drm_encoder encoder;}; struct appletbdrm_plane_state {	struct drm_shadow_plane_state base;	struct appletbdrm_fb_request *request;	struct appletbdrm_fb_request_response *response;	size_t request_size;	size_t frames_size;}; static inline struct appletbdrm_plane_state *to_appletbdrm_plane_state(struct drm_plane_state *state){	return container_of(state, struct appletbdrm_plane_state, base.base);} static int appletbdrm_send_request(struct appletbdrm_device *adev,				   struct appletbdrm_msg_request_header *request, size_t size){	struct usb_device *udev = adev_to_udev(adev);	struct drm_device *drm = &adev->drm;	int ret, actual_size; 	ret = usb_bulk_msg(udev, usb_sndbulkpipe(udev, adev->out_ep),			   request, size, &actual_size, APPLETBDRM_BULK_MSG_TIMEOUT);	if (ret) {		drm_err(drm, "Failed to send message (%d)\n", ret);		return ret;	} 	if (actual_size != size) {		drm_err(drm, "Actual size (%d) doesn't match expected size (%zu)\n",			actual_size, size);		return -EIO;	} 	return 0;} static int appletbdrm_read_response(struct appletbdrm_device *adev,				    struct appletbdrm_msg_response_header *response,				    size_t size, __le32 expected_response){	struct usb_device *udev = adev_to_udev(adev);	struct drm_device *drm = &adev->drm;	int ret, actual_size;	bool readiness_signal_received = false; retry:	ret = usb_bulk_msg(udev, usb_rcvbulkpipe(udev, adev->in_ep),			   response, size, &actual_size, APPLETBDRM_BULK_MSG_TIMEOUT);	if (ret) {		drm_err(drm, "Failed to read response (%d)\n", ret);		return ret;	} 	/*	 * The device responds to the first request sent in a particular	 * timeframe after the USB device configuration is set with a readiness	 * signal, in which case the response should be read again	 */	if (response->msg == APPLETBDRM_MSG_SIGNAL_READINESS) {		if (!readiness_signal_received) {			readiness_signal_received = true;			goto retry;		} 		drm_err(drm, "Encountered unexpected readiness signal\n");		return -EINTR;	} 	if (actual_size != size) {		drm_err(drm, "Actual size (%d) doesn't match expected size (%zu)\n",			actual_size, size);		return -EBADMSG;	} 	if (response->msg != expected_response) {		drm_err(drm, "Unexpected response from device (expected %p4cl found %p4cl)\n",			&expected_response, &response->msg);		return -EIO;	} 	return 0;} static int appletbdrm_send_msg(struct appletbdrm_device *adev, __le32 msg){	struct appletbdrm_msg_simple_request *request;	int ret; 	request = kzalloc_obj(*request);	if (!request)		return -ENOMEM; 	request->header.unk_00 = cpu_to_le16(2);	request->header.unk_02 = cpu_to_le16(0x1512);	request->header.size = cpu_to_le32(sizeof(*request) - sizeof(request->header));	request->msg = msg;	request->size = request->header.size; 	ret = appletbdrm_send_request(adev, &request->header, sizeof(*request)); 	kfree(request); 	return ret;} static int appletbdrm_clear_display(struct appletbdrm_device *adev){	return appletbdrm_send_msg(adev, APPLETBDRM_MSG_CLEAR_DISPLAY);} static int appletbdrm_signal_readiness(struct appletbdrm_device *adev){	return appletbdrm_send_msg(adev, APPLETBDRM_MSG_SIGNAL_READINESS);} static int appletbdrm_get_information(struct appletbdrm_device *adev){	struct appletbdrm_msg_information *info;	struct drm_device *drm = &adev->drm;	u8 bits_per_pixel;	__le32 pixel_format;	int ret; 	info = kzalloc_obj(*info);	if (!info)		return -ENOMEM; 	ret = appletbdrm_send_msg(adev, APPLETBDRM_MSG_GET_INFORMATION);	if (ret)		return ret; 	ret = appletbdrm_read_response(adev, &info->header, sizeof(*info),				       APPLETBDRM_MSG_GET_INFORMATION);	if (ret)		goto free_info; 	bits_per_pixel = info->bits_per_pixel;	pixel_format = get_unaligned(&info->pixel_format); 	adev->width = get_unaligned_le32(&info->width);	adev->height = get_unaligned_le32(&info->height); 	if (bits_per_pixel != APPLETBDRM_BITS_PER_PIXEL) {		drm_err(drm, "Encountered unexpected bits per pixel value (%d)\n", bits_per_pixel);		ret = -EINVAL;		goto free_info;	} 	if (pixel_format != APPLETBDRM_PIXEL_FORMAT) {		drm_err(drm, "Encountered unknown pixel format (%p4cl)\n", &pixel_format);		ret = -EINVAL;		goto free_info;	} free_info:	kfree(info); 	return ret;} static u32 rect_size(struct drm_rect *rect){	return drm_rect_width(rect) * drm_rect_height(rect) *		(BITS_TO_BYTES(APPLETBDRM_BITS_PER_PIXEL));} static int appletbdrm_connector_helper_get_modes(struct drm_connector *connector){	struct appletbdrm_device *adev = drm_to_adev(connector->dev); 	return drm_connector_helper_get_modes_fixed(connector, &adev->mode);} static const u32 appletbdrm_primary_plane_formats[] = {	DRM_FORMAT_BGR888,	DRM_FORMAT_XRGB8888, /* emulated */}; static int appletbdrm_primary_plane_helper_begin_fb_access(struct drm_plane *plane,							   struct drm_plane_state *new_plane_state){	struct appletbdrm_plane_state *appletbdrm_state = to_appletbdrm_plane_state(new_plane_state);	size_t frames_size = 0;	struct drm_atomic_helper_damage_iter iter;	struct drm_rect damage;	size_t request_size; 	drm_atomic_helper_damage_iter_init(&iter, plane->state, new_plane_state);	drm_atomic_for_each_plane_damage(&iter, &damage) {		frames_size += struct_size((struct appletbdrm_frame *)0, buf, rect_size(&damage));	} 	if (!frames_size)		return 0; 	request_size = ALIGN(sizeof(struct appletbdrm_fb_request) +		       frames_size +		       sizeof(struct appletbdrm_fb_request_footer), 16); 	appletbdrm_state->request = kvzalloc(request_size, GFP_KERNEL); 	if (!appletbdrm_state->request)		return -ENOMEM; 	appletbdrm_state->response = kzalloc_obj(*appletbdrm_state->response); 	if (!appletbdrm_state->response)		return -ENOMEM; 	appletbdrm_state->request_size = request_size;	appletbdrm_state->frames_size = frames_size; 	return drm_gem_begin_shadow_fb_access(plane, new_plane_state);} static int appletbdrm_primary_plane_helper_atomic_check(struct drm_plane *plane,							struct drm_atomic_commit *state){	struct drm_plane_state *new_plane_state = drm_atomic_get_new_plane_state(state, plane);	struct drm_crtc *new_crtc = new_plane_state->crtc;	struct drm_crtc_state *new_crtc_state = NULL;	int ret; 	if (new_crtc)		new_crtc_state = drm_atomic_get_new_crtc_state(state, new_crtc); 	ret = drm_atomic_helper_check_plane_state(new_plane_state, new_crtc_state,						  DRM_PLANE_NO_SCALING,						  DRM_PLANE_NO_SCALING,						  false, false);	if (ret)		return ret;	else if (!new_plane_state->visible)		return 0; 	return 0;} static int appletbdrm_flush_damage(struct appletbdrm_device *adev,				   struct drm_plane_state *old_state,				   struct drm_plane_state *state){	struct appletbdrm_plane_state *appletbdrm_state = to_appletbdrm_plane_state(state);	struct drm_shadow_plane_state *shadow_plane_state = to_drm_shadow_plane_state(state);	struct appletbdrm_fb_request_response *response = appletbdrm_state->response;	struct appletbdrm_fb_request_footer *footer;	struct drm_atomic_helper_damage_iter iter;	struct drm_framebuffer *fb = state->fb;	struct appletbdrm_fb_request *request = appletbdrm_state->request;	struct drm_device *drm = &adev->drm;	struct appletbdrm_frame *frame;	u64 timestamp = ktime_get_ns();	struct drm_rect damage;	size_t frames_size = appletbdrm_state->frames_size;	size_t request_size = appletbdrm_state->request_size;	int ret; 	if (!frames_size)		return 0; 	ret = drm_gem_fb_begin_cpu_access(fb, DMA_FROM_DEVICE);	if (ret) {		drm_err(drm, "Failed to start CPU framebuffer access (%d)\n", ret);		goto end_fb_cpu_access;	} 	request->header.unk_00 = cpu_to_le16(2);	request->header.unk_02 = cpu_to_le16(0x12);	request->header.unk_04 = cpu_to_le32(9);	request->header.size = cpu_to_le32(request_size - sizeof(request->header));	request->unk_10 = cpu_to_le16(1);	request->msg_id = timestamp; 	frame = (struct appletbdrm_frame *)request->data; 	drm_atomic_helper_damage_iter_init(&iter, old_state, state);	drm_atomic_for_each_plane_damage(&iter, &damage) {		struct drm_rect dst_clip = state->dst;		struct iosys_map dst = IOSYS_MAP_INIT_VADDR(frame->buf);		u32 buf_size = rect_size(&damage); 		if (!drm_rect_intersect(&dst_clip, &damage))			continue; 		/*		 * The coordinates need to be translated to the coordinate		 * system the device expects, see the comment in		 * appletbdrm_setup_mode_config		 */		frame->begin_x = cpu_to_le16(damage.y1);		frame->begin_y = cpu_to_le16(adev->height - damage.x2);		frame->width = cpu_to_le16(drm_rect_height(&damage));		frame->height = cpu_to_le16(drm_rect_width(&damage));		frame->buf_size = cpu_to_le32(buf_size); 		switch (fb->format->format) {		case DRM_FORMAT_XRGB8888:			drm_fb_xrgb8888_to_bgr888(&dst, NULL, &shadow_plane_state->data[0], fb, &damage, &shadow_plane_state->fmtcnv_state);			break;		default:			drm_fb_memcpy(&dst, NULL, &shadow_plane_state->data[0], fb, &damage);			break;		} 		frame = (void *)frame + struct_size(frame, buf, buf_size);	} 	footer = (struct appletbdrm_fb_request_footer *)&request->data[frames_size]; 	footer->unk_0c = cpu_to_le32(0xfffe);	footer->unk_1c = cpu_to_le32(0x80001);	footer->unk_34 = cpu_to_le32(0x80002);	footer->unk_4c = cpu_to_le32(0xffff);	footer->timestamp = cpu_to_le64(timestamp); 	ret = appletbdrm_send_request(adev, &request->header, request_size);	if (ret)		goto end_fb_cpu_access; 	ret = appletbdrm_read_response(adev, &response->header, sizeof(*response),				       APPLETBDRM_MSG_UPDATE_COMPLETE);	if (ret)		goto end_fb_cpu_access; 	if (response->timestamp != footer->timestamp) {		drm_err(drm, "Response timestamp (%llu) doesn't match request timestamp (%llu)\n",			le64_to_cpu(response->timestamp), timestamp);		goto end_fb_cpu_access;	} end_fb_cpu_access:	drm_gem_fb_end_cpu_access(fb, DMA_FROM_DEVICE); 	return ret;} static void appletbdrm_primary_plane_helper_atomic_update(struct drm_plane *plane,							  struct drm_atomic_commit *old_state){	struct appletbdrm_device *adev = drm_to_adev(plane->dev);	struct drm_device *drm = plane->dev;	struct drm_plane_state *plane_state = plane->state;	struct drm_plane_state *old_plane_state = drm_atomic_get_old_plane_state(old_state, plane);	int idx; 	if (!drm_dev_enter(drm, &idx))		return; 	appletbdrm_flush_damage(adev, old_plane_state, plane_state); 	drm_dev_exit(idx);} static void appletbdrm_primary_plane_helper_atomic_disable(struct drm_plane *plane,							   struct drm_atomic_commit *state){	struct drm_device *dev = plane->dev;	struct appletbdrm_device *adev = drm_to_adev(dev);	int idx; 	if (!drm_dev_enter(dev, &idx))

Lines 1–500 of 841.