Commit 31214108 authored by Alexandre Courbot's avatar Alexandre Courbot Committed by Ben Skeggs
Browse files

drm/nouveau/core: add falcon library functions 



Falcon processors are used in various places of GPU chips. Although there
exist different versions of the falcon, and some variants exist, the
base set of actions performed on them is the same, which results in lots
of duplicated code.

This patch consolidates the current nvkm_falcon structure and extends it
with the following features:

* Ability for an engine to obtain and later release a given falcon,
* Abstractions for basic operations (IMEM/DMEM access, start, etc)
* Abstractions for secure operations if a falcon is secure

Abstractions make it easy to e.g. start a falcon, without having to care
about its details. For instance, falcons in secure mode need to be
started by writing to a different register.

Right now the abstractions variants only cover secure vs. non-secure
falcon, but more will come as e.g. SEC2 support is added.

This is still a WIP as other functions previously done by
engine/falcon.c need to be reimplemented. However this first step allows
to keep things simple and to discuss basic design.

Signed-off-by: default avatarAlexandre Courbot <acourbot@nvidia.com>
Signed-off-by: default avatarBen Skeggs <bskeggs@redhat.com>
parent c599dd4b

drivers/gpu/drm/nouveau/include/nvkm/engine/falcon.h

+72 −4
Original line number Diff line number Diff line
@@ -4,13 +4,26 @@ 
#include <core/engine.h>

struct nvkm_fifo_chan;



enum nvkm_falcon_dmaidx {

	FALCON_DMAIDX_UCODE		= 0,

	FALCON_DMAIDX_VIRT		= 1,

	FALCON_DMAIDX_PHYS_VID		= 2,

	FALCON_DMAIDX_PHYS_SYS_COH	= 3,

	FALCON_DMAIDX_PHYS_SYS_NCOH	= 4,

};



struct nvkm_falcon {

	const struct nvkm_falcon_func *func;

	struct nvkm_engine engine;



	const struct nvkm_subdev *owner;

	const char *name;

	u32 addr;



	struct mutex mutex;

	const struct nvkm_subdev *user;



	u8 version;

	u8 secret;

	bool debug;



	struct nvkm_memory *core;

	bool external;
@@ -19,15 +32,25 @@ struct nvkm_falcon { 
		u32 limit;

		u32 *data;

		u32  size;

		u8 ports;

	} code;



	struct {

		u32 limit;

		u32 *data;

		u32  size;

		u8 ports;

	} data;



	struct nvkm_engine engine;

};



int nvkm_falcon_v1_new(struct nvkm_subdev *owner, const char *name, u32 addr,

		       struct nvkm_falcon **);

void nvkm_falcon_del(struct nvkm_falcon **);

int nvkm_falcon_get(struct nvkm_falcon *, const struct nvkm_subdev *);

void nvkm_falcon_put(struct nvkm_falcon *, const struct nvkm_subdev *);



int nvkm_falcon_new_(const struct nvkm_falcon_func *, struct nvkm_device *,

		     int index, bool enable, u32 addr, struct nvkm_engine **);
@@ -42,6 +65,51 @@ struct nvkm_falcon_func { 
	} data;

	void (*init)(struct nvkm_falcon *);

	void (*intr)(struct nvkm_falcon *, struct nvkm_fifo_chan *);

	void (*load_imem)(struct nvkm_falcon *, void *, u32, u32, u16, u8, bool);

	void (*load_dmem)(struct nvkm_falcon *, void *, u32, u32, u8);

	void (*read_dmem)(struct nvkm_falcon *, u32, u32, u8, void *);

	void (*bind_context)(struct nvkm_falcon *, struct nvkm_gpuobj *);

	int (*wait_for_halt)(struct nvkm_falcon *, u32);

	int (*clear_interrupt)(struct nvkm_falcon *, u32);

	void (*set_start_addr)(struct nvkm_falcon *, u32 start_addr);

	void (*start)(struct nvkm_falcon *);

	int (*enable)(struct nvkm_falcon *falcon);

	void (*disable)(struct nvkm_falcon *falcon);



	struct nvkm_sclass sclass[];

};



static inline u32

nvkm_falcon_rd32(struct nvkm_falcon *falcon, u32 addr)

{

	return nvkm_rd32(falcon->owner->device, falcon->addr + addr);

}



static inline void

nvkm_falcon_wr32(struct nvkm_falcon *falcon, u32 addr, u32 data)

{

	nvkm_wr32(falcon->owner->device, falcon->addr + addr, data);

}



static inline u32

nvkm_falcon_mask(struct nvkm_falcon *falcon, u32 addr, u32 mask, u32 val)

{

	struct nvkm_device *device = falcon->owner->device;



	return nvkm_mask(device, falcon->addr + addr, mask, val);

}



void nvkm_falcon_load_imem(struct nvkm_falcon *, void *, u32, u32, u16, u8,

			   bool);

void nvkm_falcon_load_dmem(struct nvkm_falcon *, void *, u32, u32, u8);

void nvkm_falcon_read_dmem(struct nvkm_falcon *, u32, u32, u8, void *);

void nvkm_falcon_bind_context(struct nvkm_falcon *, struct nvkm_gpuobj *);

void nvkm_falcon_set_start_addr(struct nvkm_falcon *, u32);

void nvkm_falcon_start(struct nvkm_falcon *);

int nvkm_falcon_wait_for_halt(struct nvkm_falcon *, u32);

int nvkm_falcon_clear_interrupt(struct nvkm_falcon *, u32);

int nvkm_falcon_enable(struct nvkm_falcon *);

void nvkm_falcon_disable(struct nvkm_falcon *);

int nvkm_falcon_reset(struct nvkm_falcon *);



#endif

drivers/gpu/drm/nouveau/nvkm/Kbuild

+1 −0
Original line number Diff line number Diff line 
include $(src)/nvkm/core/Kbuild

include $(src)/nvkm/falcon/Kbuild

include $(src)/nvkm/subdev/Kbuild

include $(src)/nvkm/engine/Kbuild

drivers/gpu/drm/nouveau/nvkm/falcon/Kbuild

0 → 100644
+2 −0
Original line number Diff line number Diff line 
nvkm-y += nvkm/falcon/base.o

nvkm-y += nvkm/falcon/v1.o

drivers/gpu/drm/nouveau/nvkm/falcon/base.c

0 → 100644
+191 −0
Original line number Diff line number Diff line 
/*

 * Copyright (c) 2016, NVIDIA CORPORATION. All rights reserved.

 *

 * Permission is hereby granted, free of charge, to any person obtaining a

 * copy of this software and associated documentation files (the "Software"),

 * to deal in the Software without restriction, including without limitation

 * the rights to use, copy, modify, merge, publish, distribute, sublicense,

 * and/or sell copies of the Software, and to permit persons to whom the

 * Software is furnished to do so, subject to the following conditions:

 *

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 *

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL

 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER

 * DEALINGS IN THE SOFTWARE.

 */

#include "priv.h"



#include <subdev/mc.h>



void

nvkm_falcon_load_imem(struct nvkm_falcon *falcon, void *data, u32 start,

		      u32 size, u16 tag, u8 port, bool secure)

{

	if (secure && !falcon->secret) {

		nvkm_warn(falcon->user,

			  "writing with secure tag on a non-secure falcon!\n");

		return;

	}



	falcon->func->load_imem(falcon, data, start, size, tag, port,

				secure);

}



void

nvkm_falcon_load_dmem(struct nvkm_falcon *falcon, void *data, u32 start,

		      u32 size, u8 port)

{

	falcon->func->load_dmem(falcon, data, start, size, port);

}



void

nvkm_falcon_read_dmem(struct nvkm_falcon *falcon, u32 start, u32 size, u8 port,

		      void *data)

{

	falcon->func->read_dmem(falcon, start, size, port, data);

}



void

nvkm_falcon_bind_context(struct nvkm_falcon *falcon, struct nvkm_gpuobj *inst)

{

	if (!falcon->func->bind_context) {

		nvkm_error(falcon->user,

			   "Context binding not supported on this falcon!\n");

		return;

	}



	falcon->func->bind_context(falcon, inst);

}



void

nvkm_falcon_set_start_addr(struct nvkm_falcon *falcon, u32 start_addr)

{

	falcon->func->set_start_addr(falcon, start_addr);

}



void

nvkm_falcon_start(struct nvkm_falcon *falcon)

{

	falcon->func->start(falcon);

}



int

nvkm_falcon_enable(struct nvkm_falcon *falcon)

{

	struct nvkm_device *device = falcon->owner->device;

	enum nvkm_devidx id = falcon->owner->index;

	int ret;



	nvkm_mc_enable(device, id);

	ret = falcon->func->enable(falcon);

	if (ret) {

		nvkm_mc_disable(device, id);

		return ret;

	}



	return 0;

}



void

nvkm_falcon_disable(struct nvkm_falcon *falcon)

{

	struct nvkm_device *device = falcon->owner->device;

	enum nvkm_devidx id = falcon->owner->index;



	/* already disabled, return or wait_idle will timeout */

	if (!nvkm_mc_enabled(device, id))

		return;



	falcon->func->disable(falcon);



	nvkm_mc_disable(device, id);

}



int

nvkm_falcon_reset(struct nvkm_falcon *falcon)

{

	nvkm_falcon_disable(falcon);

	return nvkm_falcon_enable(falcon);

}



int

nvkm_falcon_wait_for_halt(struct nvkm_falcon *falcon, u32 ms)

{

	return falcon->func->wait_for_halt(falcon, ms);

}



int

nvkm_falcon_clear_interrupt(struct nvkm_falcon *falcon, u32 mask)

{

	return falcon->func->clear_interrupt(falcon, mask);

}



void

nvkm_falcon_put(struct nvkm_falcon *falcon, const struct nvkm_subdev *user)

{

	mutex_lock(&falcon->mutex);

	if (falcon->user == user) {

		nvkm_debug(falcon->user, "released %s falcon\n", falcon->name);

		falcon->user = NULL;

	}

	mutex_unlock(&falcon->mutex);

}



int

nvkm_falcon_get(struct nvkm_falcon *falcon, const struct nvkm_subdev *user)

{

	mutex_lock(&falcon->mutex);

	if (falcon->user) {

		nvkm_error(user, "%s falcon already acquired by %s!\n",

			   falcon->name, nvkm_subdev_name[falcon->user->index]);

		mutex_unlock(&falcon->mutex);

		return -EBUSY;

	}



	nvkm_debug(user, "acquired %s falcon\n", falcon->name);

	falcon->user = user;

	mutex_unlock(&falcon->mutex);

	return 0;

}



void

nvkm_falcon_ctor(const struct nvkm_falcon_func *func,

		 struct nvkm_subdev *subdev, const char *name, u32 addr,

		 struct nvkm_falcon *falcon)

{

	u32 reg;



	falcon->func = func;

	falcon->owner = subdev;

	falcon->name = name;

	falcon->addr = addr;

	mutex_init(&falcon->mutex);



	reg = nvkm_falcon_rd32(falcon, 0x12c);

	falcon->version = reg & 0xf;

	falcon->secret = (reg >> 4) & 0x3;

	falcon->code.ports = (reg >> 8) & 0xf;

	falcon->data.ports = (reg >> 12) & 0xf;



	reg = nvkm_falcon_rd32(falcon, 0x108);

	falcon->code.limit = (reg & 0x1ff) << 8;

	falcon->data.limit = (reg & 0x3fe00) >> 1;



	reg = nvkm_falcon_rd32(falcon, 0xc08);

	falcon->debug = (reg >> 20) & 0x1;

}



void

nvkm_falcon_del(struct nvkm_falcon **pfalcon)

{

	if (*pfalcon) {

		kfree(*pfalcon);

		*pfalcon = NULL;

	}

}

drivers/gpu/drm/nouveau/nvkm/falcon/priv.h

0 → 100644
+8 −0
Original line number Diff line number Diff line 
#ifndef __NVKM_FALCON_PRIV_H__

#define __NVKM_FALCON_PRIV_H__

#include <engine/falcon.h>



void

nvkm_falcon_ctor(const struct nvkm_falcon_func *, struct nvkm_subdev *,

		 const char *, u32, struct nvkm_falcon *);

#endif

CRA Git | Maintained and supported by SUSTech CRA and CCSE